diff --git a/.gitignore b/.gitignore index 92eee2617..c922f6eec 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,8 @@ Netburner.txt /test/*.bundle.* /test/*.css /input/bitburner.api.json +dist/bitburner.d.ts +dist/images .cypress # tmp folder for build and electron diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts deleted file mode 100644 index ccc25946c..000000000 --- a/dist/bitburner.d.ts +++ /dev/null @@ -1,7984 +0,0 @@ -/** @public */ -export declare interface ActiveFragment { - id: number; - highestCharge: number; - numCharge: number; - rotation: number; - x: number; - y: number; -} - -/** - * Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} - * @public - */ -export declare interface AugmentPair { - /** augmentation name */ - name: string; - /** augmentation cost */ - cost: number; -} - -/** - * Used for autocompletion - * @public - */ -export declare interface AutocompleteData { - servers: string[]; - scripts: string[]; - txts: string[]; - flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; -} - -/** - * Options to affect the behavior of {@link NS.hack | hack}, {@link NS.grow | grow}, and {@link NS.weaken | weaken}. - * @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; - /** Set to true this action will affect the stock market. */ - stock?: boolean; -} - -/** - * All multipliers affecting the difficulty of the current challenge. - * @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 money gain from dividends of corporations created by the player. */ - CorporationSoftcap: number; - /** Influences the valuation of corporations created by the player. */ - CorporationValuation: number; - /** Influences the base experience gained for each ability when the player commits a crime. */ - 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 respect gain and money gain of your gang. */ - GangSoftcap: 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 cost of any purchased server at or above 128GB */ - PurchasedServerSoftcap: number; - /** Influences the minimum favor the player must have with a faction before they can donate to gain rep. */ - RepToDonateToFaction: number; - /** Influences how much the money on a server can be reduced when a script performs a hack against it. */ - ScriptHackMoney: number; - /** Influences how much of the money stolen by a scripted hack will be added to the player's money. */ - ScriptHackMoneyGain: number; - /** Influences the growth percentage per cycle against a server. */ - ServerGrowthRate: number; - /** Influences the maximum 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; - /** Influences the power of the gift */ - StaneksGiftPowerMultiplier: number; - /** Influences the size of the gift */ - StaneksGiftExtraSize: number; - /** Influences the hacking skill required to backdoor the world daemon. */ - WorldDaemonDifficulty: number; -} - -/** - * Bladeburner API - * @remarks - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this API. - * @public - */ -export declare interface Bladeburner { - /** - * List all contracts. - * @remarks - * RAM cost: 0.4 GB - * - * Returns an array of strings containing the names of all Bladeburner contracts. - * - * @returns Array of strings containing the names of all Bladeburner contracts. - */ - getContractNames(): string[]; - - /** - * List all operations. - * @remarks - * RAM cost: 0.4 GB - * - * Returns an array of strings containing the names of all Bladeburner operations. - * - * @returns Array of strings containing the names of all Bladeburner operations. - */ - getOperationNames(): string[]; - - /** - * List all black ops. - * @remarks - * RAM cost: 0.4 GB - * - * Returns an array of strings containing the names of all Bladeburner Black Ops. - * - * @returns Array of strings containing the names of all Bladeburner Black Ops. - */ - getBlackOpNames(): string[]; - - /** - * List all general actions. - * @remarks - * RAM cost: 0.4 GB - * - * Returns an array of strings containing the names of all general Bladeburner actions. - * - * @returns Array of strings containing the names of all general Bladeburner actions. - */ - getGeneralActionNames(): string[]; - - /** - * List all skills. - * @remarks - * RAM cost: 0.4 GB - * - * Returns an array of strings containing the names of all general Bladeburner skills. - * - * @returns Array of strings containing the names of all general Bladeburner skills. - */ - getSkillNames(): string[]; - - /** - * Start an action. - * @remarks - * RAM cost: 4 GB - * - * Attempts to start the specified Bladeburner action. - * Returns true if the action was started successfully, and false otherwise. - * - * @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: string, name: string): boolean; - - /** - * Stop current action. - * @remarks - * RAM cost: 2 GB - * - * Stops the current Bladeburner action. - * - */ - stopBladeburnerAction(): void; - - /** - * Get current action. - * @remarks - * RAM cost: 1 GB - * - * 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”. - * - * @returns Object that represents the player’s current Bladeburner action. - */ - getCurrentAction(): BladeburnerCurAction; - - /** - * Get the time to complete an action. - * @remarks - * RAM cost: 4 GB - * - * Returns the number of milliseconds it takes to complete the specified action - * - * @param type - Type of action. - * @param name - Name of action. Must be an exact match. - * @returns Number of milliseconds it takes to complete the specified action. - */ - getActionTime(type: string, name: string): number; - - /** - * Get the time elapsed on current action. - * @remarks - * RAM cost: 4 GB - * - * Returns the number of milliseconds already spent on the current action. - * - * @returns Number of milliseconds already spent on the current action. - */ - getActionCurrentTime(): number; - - /** - * Get estimate success chance of an action. - * @remarks - * RAM cost: 4 GB - * - * 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). - * - * @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: string, name: string): [number, number]; - - /** - * Get the reputation gain of an action. - * @remarks - * RAM cost: 4 GB - * - * 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. - * - * @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: string, name: string, level: number): number; - - /** - * Get action count remaining. - * @remarks - * RAM cost: 4 GB - * - * Returns the remaining count of the specified action. - * - * Note that this is meant to be used for Contracts and Operations. - * This function will return ‘Infinity’ for actions such as Training and Field Analysis. - * This function will return 1 for BlackOps not yet completed regardless of whether - * the player has the required rank to attempt the mission or not. - * - * @param type - Type of action. - * @param name - Name of action. Must be an exact match. - * @returns Remaining count of the specified action. - */ - getActionCountRemaining(type: string, name: string): number; - - /** - * Get the maximum level of an action. - * @remarks - * RAM cost: 4 GB - * - * Returns the maximum level for this action. - * - * Returns -1 if an invalid action is specified. - * - * @param type - Type of action. - * @param name - Name of action. Must be an exact match. - * @returns Maximum level of the specified action. - */ - getActionMaxLevel(type: string, name: string): number; - - /** - * Get the current level of an action. - * @remarks - * RAM cost: 4 GB - * - * Returns the current level of this action. - * - * Returns -1 if an invalid action is specified. - * - * @param type - Type of action. - * @param name - Name of action. Must be an exact match. - * @returns Current level of the specified action. - */ - getActionCurrentLevel(type: string, name: string): number; - - /** - * Get whether an action is set to autolevel. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not this action is currently set to autolevel. - * - * Returns false if an invalid action is specified. - * - * @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: string, name: string): boolean; - - /** - * Set an action autolevel. - * @remarks - * RAM cost: 4 GB - * - * Enable/disable autoleveling for the specified action. - * - * @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: string, name: string, autoLevel: boolean): void; - - /** - * Set the level of an action. - * @remarks - * RAM cost: 4 GB - * - * Set the level for the specified action. - * - * @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: string, name: string, level: number): void; - - /** - * Get player bladeburner rank. - * @remarks - * RAM cost: 4 GB - * - * Returns the player’s Bladeburner Rank. - * - * @returns Player’s Bladeburner Rank. - */ - getRank(): number; - - /** - * Get black op required rank. - * @remarks - * RAM cost: 2 GB - * - * Returns the rank required to complete this BlackOp. - * - * Returns -1 if an invalid action is specified. - * - * @param name - Name of BlackOp. Must be an exact match. - * @returns Rank required to complete this BlackOp. - */ - getBlackOpRank(name: string): number; - - /** - * Get bladeburner skill points. - * @remarks - * RAM cost: 4 GB - * - * Returns the number of Bladeburner skill points you have. - * - * @returns Number of Bladeburner skill points you have. - */ - getSkillPoints(): number; - - /** - * Get skill level. - * @remarks - * RAM cost: 4 GB - * - * This function returns your level in the specified skill. - * - * The function returns -1 if an invalid skill name is passed in. - * - * @param skillName - Name of skill. Case-sensitive and must be an exact match - * @returns Level in the specified skill. - */ - getSkillLevel(name: string): number; - - /** - * Get cost to upgrade skill. - * @remarks - * RAM cost: 4 GB - * - * This function returns the number of skill points needed to upgrade the specified skill the specified number of times. - * - * The function returns -1 if an invalid skill name is passed in. - * - * @param skillName - Name of skill. Case-sensitive and must be an exact match - * @param count - Number of times to upgrade the skill. Defaults to 1 if not specified. - * @returns Number of skill points needed to upgrade the specified skill. - */ - getSkillUpgradeCost(name: string, count?: number): number; - - /** - * Upgrade skill. - * @remarks - * RAM cost: 4 GB - * - * Attempts to upgrade the specified Bladeburner skill the specified number of times. - * - * Returns true if the skill is successfully upgraded, and false otherwise. - * - * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match - * @param count - Number of times to upgrade the skill. Defaults to 1 if not specified. - * @returns true if the skill is successfully upgraded, and false otherwise. - */ - upgradeSkill(name: string, count?: number): boolean; - - /** - * Get team size. - * @remarks - * RAM cost: 4 GB - * - * 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. - * - * @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: string, name: string): number; - - /** - * Set team size. - * @remarks - * RAM cost: 4 GB - * - * Set the team size for the specified Bladeburner action. - * - * Returns the team size that was set, or -1 if the function failed. - * - * @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: string, name: string, size: number): number; - - /** - * Get estimated population in city. - * @remarks - * RAM cost: 4 GB - * - * Returns the estimated number of Synthoids in the specified city, - * or -1 if an invalid city was specified. - * - * @param city - Name of city. Case-sensitive - * @returns Estimated number of Synthoids in the specified city. - */ - getCityEstimatedPopulation(city: CityName | `${CityName}`): number; - - /** - * Get number of communities in a city. - * @remarks - * RAM cost: 4 GB - * - * Returns the estimated number of Synthoid communities in the specified city, - * or -1 if an invalid city was specified. - * - * @param city - Name of city. Case-sensitive - * @returns Number of Synthoids communities in the specified city. - */ - getCityCommunities(city: CityName | `${CityName}`): number; - - /** - * Get chaos of a city. - * @remarks - * RAM cost: 4 GB - * - * Returns the chaos in the specified city, - * or -1 if an invalid city was specified. - * - * @param city - Name of city. Case-sensitive - * @returns Chaos in the specified city. - */ - getCityChaos(city: CityName | `${CityName}`): number; - - /** - * Get current city. - * @remarks - * RAM cost: 4 GB - * - * Returns the city that the player is currently in (for Bladeburner). - * - * @returns City that the player is currently in (for Bladeburner). - */ - getCity(): CityName; - - /** - * Travel to another city in bladeburner. - * @remarks - * RAM cost: 4 GB - * Attempts to switch to the specified city (for Bladeburner only). - * - * Returns true if successful, and false otherwise - * - * @param city - Name of city. Case-sensitive - * @returns true if successful, and false otherwise - */ - switchCity(city: CityName | `${CityName}`): boolean; - - /** - * Get bladeburner stamina. - * @remarks - * RAM cost: 4 GB - * Returns an array with two elements: - * * [Current stamina, Max stamina] - * @example - * ```ts - * // NS1: - * function getStaminaPercentage() { - * var res = bladeburner.getStamina(); - * return res[0] / res[1]; - * } - * ``` - * @example - * ```ts - * // NS2: - * function getStaminaPercentage() { - * const [current, max] = ns.bladeburner.getStamina(); - * return current / max; - * } - * ``` - * @returns Array containing current stamina and max stamina. - */ - getStamina(): [number, number]; - - /** - * Join the bladeburner faction. - * @remarks - * RAM cost: 4 GB - * 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. - * - * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. - */ - joinBladeburnerFaction(): boolean; - - /** - * Join the bladeburner division. - * @remarks - * RAM cost: 4 GB - * - * 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. - * - * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. - */ - joinBladeburnerDivision(): boolean; - - /** - * Get bladeburner bonus time. - * @remarks - * RAM cost: 0 GB - * - * Returns the amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. - * - * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. - * - * “Bonus time” 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. - * - * @returns Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. - */ - getBonusTime(): number; - - /** Returns whether player is a member of bladeburner division. Does not require API access. - * @remarks - * RAM cost: 1 GB - * - * @returns whether player is a member of bladeburner division. */ - inBladeburner(): boolean; -} - -/** - * Bladeburner current action. - * @public - */ -export declare interface BladeburnerCurAction { - /** Type of Action */ - type: string; - /** Name of Action */ - name: string; -} - -/** Names of all cities - * @public */ -export declare enum CityName { - Aevum = "Aevum", - Chongqing = "Chongqing", - Sector12 = "Sector-12", - NewTokyo = "New Tokyo", - Ishima = "Ishima", - Volhaven = "Volhaven", -} - -/** - * Coding Contract API - * @public - */ -export declare interface CodingContract { - /** - * Attempts a coding contract, returning a reward string on success or empty string on failure. - * @remarks - * RAM cost: 10 GB - * - * Attempts to solve the Coding Contract with the provided solution. - * - * @example - * ```js - * // NS1 - * var reward = codingcontract.attempt(yourSolution, filename, hostname); - * if (reward) { - * tprint("Contract solved successfully! Reward: " + reward) - * } else tprint("Failed to solve contract.") - * ``` - * @example - * ```js - * // NS2 - * const reward = codingcontract.attempt(yourSolution, filename, hostname); - * if (reward) { - * ns.tprint(`Contract solved successfully! Reward: ${reward}`) - * } else ns.tprint("Failed to solve contract.") - * ``` - * - * @param answer - Attempted solution for the contract. - * @param filename - Filename of the contract. - * @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not - * provided. - * @returns A reward description string on success, or an empty string on failure. - */ - attempt(answer: string | number | any[], filename: string, host?: string): string; - - /** - * Get the type of a coding contract. - * @remarks - * RAM cost: 5 GB - * - * Returns a name describing the type of problem posed by the Coding Contract. - * (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) - * - * @param filename - Filename of the contract. - * @param host - Hostname 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(filename: string, host?: string): string; - - /** - * Get the description. - * @remarks - * RAM cost: 5 GB - * - * Get the full text description for the problem posed by the Coding Contract. - * - * @param filename - Filename of the contract. - * @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns Contract’s text description. - */ - getDescription(filename: string, host?: string): string; - - /** - * Get the input data. - * @remarks - * RAM cost: 5 GB - * - * 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 the contract. - * - * @param filename - Filename of the contract. - * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns The specified contract’s data, data type depends on contract type. - */ - getData(filename: string, host?: string): CodingContractData; - - /** - * Get the number of attempts remaining. - * @remarks - * RAM cost: 2 GB - * - * Get the number of tries remaining on the contract before it self-destructs. - * - * @param filename - Filename of the contract. - * @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns How many attempts are remaining for the contract. - */ - getNumTriesRemaining(filename: string, host?: string): number; - - /** - * Generate a dummy contract. - * @remarks - * RAM cost: 2 GB - * - * Generate a dummy contract on the home computer with no reward. Used to test various algorithms. - * - * @param type - Type of contract to generate - */ - createDummyContract(type: string): void; - - /** - * List all contract types. - * @remarks - * RAM cost: 2 GB - */ - getContractTypes(): string[]; -} - -/** - * Coding contract data will differ depending on coding contract. - * @public - */ -export declare type CodingContractData = any; - -/** - * Corporation related constants - * @public - */ -export declare interface CorpConstants { - /** Names of all corporation game states */ - stateNames: CorpStateName[]; - /** Names of all industries */ - industryNames: CorpIndustryName[]; - /** Names of all materials */ - materialNames: CorpMaterialName[]; - /** Names of all one-time corporation-wide unlocks */ - unlockNames: CorpUnlockName[]; - /** Names of all corporation-wide upgrades */ - upgradeNames: CorpUpgradeName[]; - /** Names of all researches common to all industries */ - researchNamesBase: CorpResearchName[]; - /** Names of all researches only available to product industries */ - researchNamesProductOnly: CorpResearchName[]; - /** Names of all researches */ - researchNames: CorpResearchName[]; - initialShares: number; - /** When selling large number of shares, price is dynamically updated for every batch of this amount */ - sharesPerPriceUpdate: number; - /** Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) */ - issueNewSharesCooldown: number; - /** Cooldown for selling shares in game cycles (1 game cycle = 200ms) */ - sellSharesCooldown: number; - coffeeCostPerEmployee: number; - gameCyclesPerMarketCycle: number; - gameCyclesPerCorpStateCycle: number; - secondsPerMarketCycle: number; - warehouseInitialCost: number; - warehouseInitialSize: number; - warehouseSizeUpgradeCostBase: number; - officeInitialCost: number; - officeInitialSize: number; - officeSizeUpgradeCostBase: number; - bribeThreshold: number; - bribeAmountPerReputation: number; - baseProductProfitMult: number; - dividendMaxRate: number; - /** Conversion factor for employee stats to initial salary */ - employeeSalaryMultiplier: number; - marketCyclesPerEmployeeRaise: number; - employeeRaiseAmount: number; - /** Max products for a division without upgrades */ - maxProductsBase: number; - /** The minimum decay value for happiness/morale/energy */ - minEmployeeDecay: number; -} - -/** @public */ -export declare type CorpEmployeePosition = -| "Operations" -| "Engineer" -| "Business" -| "Management" -| "Research & Development" -| "Training" -| "Unassigned"; - -/** Data for an individual industry - * @public */ -export declare interface CorpIndustryData { - startingCost: number; - description: string; - product?: CorpProductData; - recommendStarting: boolean; - requiredMaterials: Partial>; - /** Real estate factor */ - realEstateFactor?: number; - /** Scientific research factor (affects quality) */ - scienceFactor?: number; - /** Hardware factor */ - hardwareFactor?: number; - /** Robots factor */ - robotFactor?: number; - /** AI Cores factor */ - aiCoreFactor?: number; - /** Advertising factor (affects sales) */ - advertisingFactor?: number; - producedMaterials?: CorpMaterialName[]; -} - -/** @public */ -export declare type CorpIndustryName = -| "Energy" -| "Water Utilities" -| "Agriculture" -| "Fishing" -| "Mining" -| "Food" -| "Tobacco" -| "Chemical" -| "Pharmaceutical" -| "Computer Hardware" -| "Robotics" -| "Software" -| "Healthcare" -| "Real Estate"; - -/** - * Corporation material information - * @public - */ -export declare interface CorpMaterialConstantData { - /** Name of the material */ - name: string; - /** Size of the material */ - size: number; - demandBase: number; - /** Min and max demand */ - demandRange: [min: number, max: number]; - competitionBase: number; - competitionRange: [min: number, max: number]; - baseCost: number; - maxVolatility: number; - baseMarkup: number; -} - -/** @public */ -export declare type CorpMaterialName = -| "Water" -| "Energy" -| "Food" -| "Plants" -| "Metal" -| "Hardware" -| "Chemicals" -| "Drugs" -| "Robots" -| "AI Cores" -| "Real Estate"; - -/** - * Corporation API - * @public - */ -export declare interface Corporation extends WarehouseAPI, OfficeAPI { - /** Returns whether the player has a corporation. Does not require API access. - * @returns whether the player has a corporation */ - hasCorporation(): boolean; - - /** Create a Corporation - * @param corporationName - Name of the corporation - * @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3 - * @returns true if created and false if not */ - createCorporation(corporationName: string, selfFund: boolean): boolean; - - /** Check if you have a one time unlockable upgrade - * @param upgradeName - Name of the upgrade - * @returns true if unlocked and false if not */ - hasUnlockUpgrade(upgradeName: string): boolean; - - /** Gets the cost to unlock a one time unlockable upgrade - * @param upgradeName - Name of the upgrade - * @returns cost of the upgrade */ - getUnlockUpgradeCost(upgradeName: string): number; - - /** Get the level of a levelable upgrade - * @param upgradeName - Name of the upgrade - * @returns the level of the upgrade */ - getUpgradeLevel(upgradeName: string): number; - - /** Gets the cost to unlock the next level of a levelable upgrade - * @param upgradeName - Name of the upgrade - * @returns cost of the upgrade */ - getUpgradeLevelCost(upgradeName: string): number; - - /** Get an offer for investment based on you companies current valuation - * @returns An offer of investment */ - getInvestmentOffer(): InvestmentOffer; - - /** Get corporation related constants - * @returns corporation related constants */ - getConstants(): CorpConstants; - - /** Get constant industry definition data for a specific industry */ - getIndustryData(industryName: CorpIndustryName): CorpIndustryData; - - /** Get constant data for a specific material */ - getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData; - - /** Accept investment based on you companies current valuation - * @remarks - * Is based on current valuation and will not honer a specific Offer - * @returns An offer of investment */ - acceptInvestmentOffer(): boolean; - - /** Go public - * @param numShares - number of shares you would like to issue for your IPO - * @returns true if you successfully go public, false if not */ - goPublic(numShares: number): boolean; - - /** Bribe a faction - * @param factionName - Faction name - * @param amountCash - Amount of money to bribe - * @returns True if successful, false if not */ - bribe(factionName: string, amountCash: number): boolean; - - /** Get corporation data - * @returns Corporation data */ - getCorporation(): CorporationInfo; - - /** Get division data - * @param divisionName - Name of the division - * @returns Division data */ - getDivision(divisionName: string): Division; - - /** Expand to a new industry - * @param industryType - Name of the industry - * @param divisionName - Name of the division */ - expandIndustry(industryType: CorpIndustryName, divisionName: string): void; - - /** Expand to a new city - * @param divisionName - Name of the division - * @param city - Name of the city */ - expandCity(divisionName: string, city: CityName | `${CityName}`): void; - - /** Unlock an upgrade - * @param upgradeName - Name of the upgrade */ - unlockUpgrade(upgradeName: string): void; - - /** Level an upgrade. - * @param upgradeName - Name of the upgrade */ - levelUpgrade(upgradeName: string): void; - - /** Issue dividends - * @param rate - Fraction of profit to issue as dividends. */ - issueDividends(rate: number): void; - - /** Issue new shares - * @param amount - Number of new shares to issue, will be rounded to nearest 10m. Defaults to max amount. - * @returns Amount of funds generated for the corporation. */ - issueNewShares(amount?: number): number; - - /** Buyback Shares - * @param amount - Amount of shares to buy back. */ - buyBackShares(amount: number): void; - - /** Sell Shares - * @param amount - Amount of shares to sell. */ - sellShares(amount: number): void; - - /** Get bonus time. - * “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. - * @returns Bonus time for the Corporation mechanic in milliseconds. */ - getBonusTime(): number; -} - -/** - * General info about a corporation - * @public - */ -export declare interface CorporationInfo { - /** Name of the corporation */ - name: string; - /** Funds available */ - funds: number; - /** Revenue per second this cycle */ - revenue: number; - /** Expenses per second this cycle */ - expenses: number; - /** Indicating if the company is public */ - public: boolean; - /** Total number of shares issues by this corporation */ - totalShares: number; - /** Amount of share owned */ - numShares: number; - /** Cooldown until shares can be sold again */ - shareSaleCooldown: number; - /** Amount of acquirable shares. */ - issuedShares: number; - /** Price of the shares */ - sharePrice: number; - /** Fraction of profits issued as dividends */ - dividendRate: number; - /** Tax applied on your earnings as a shareholder */ - dividendTax: number; - /** Your earnings as a shareholder per second this cycle */ - dividendEarnings: number; - /** State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. */ - state: string; - /** Array of all division names */ - divisions: string[]; -} - -/** Product rating information - * @public */ -export declare type CorpProductData = { - /** Name of the product */ - name: string; - /** Verb used to describe creation of the product */ - verb: string; - /** Description of product creation */ - desc: string; - /** Weighting factors for product */ - ratingWeights: { - aesthetics?: number; - durability?: number; - features?: number; - quality?: number; - performance?: number; - reliability?: number; - }; -}; - -/** @public */ -export declare type CorpResearchName = -| "Hi-Tech R&D Laboratory" -| "AutoBrew" -| "AutoPartyManager" -| "Automatic Drug Administration" -| "Bulk Purchasing" -| "CPH4 Injections" -| "Drones" -| "Drones - Assembly" -| "Drones - Transport" -| "Go-Juice" -| "HRBuddy-Recruitment" -| "HRBuddy-Training" -| "JoyWire" -| "Market-TA.I" -| "Market-TA.II" -| "Overclock" -| "Self-Correcting Assemblers" -| "Sti.mu" -| "uPgrade: Capacity.I" -| "uPgrade: Capacity.II" -| "uPgrade: Dashboard" -| "uPgrade: Fulcrum" -| "sudo.Assist"; - -/** @public */ -export declare type CorpStateName = "START" | "PURCHASE" | "PRODUCTION" | "SALE" | "EXPORT"; - -/** @public */ -export declare type CorpUnlockName = -| "Export" -| "Smart Supply" -| "Market Research - Demand" -| "Market Data - Competition" -| "VeChain" -| "Shady Accounting" -| "Government Partnership" -| "Warehouse API" -| "Office API"; - -/** @public */ -export declare type CorpUpgradeName = -| "Smart Factories" -| "Smart Storage" -| "DreamSense" -| "Wilson Analytics" -| "Nuoptimal Nootropic Injector Implants" -| "Speech Processor Implants" -| "Neural Accelerators" -| "FocusWires" -| "ABC SalesBots" -| "Project Insight"; - -/** - * Data representing the internal values of a crime. - * @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; - /** 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 enum CrimeType { - shoplift = "Shoplift", - robStore = "Rob Store", - mug = "Mug", - larceny = "Larceny", - dealDrugs = "Deal Drugs", - bondForgery = "Bond Forgery", - traffickArms = "Traffick Arms", - homicide = "Homicide", - grandTheftAuto = "Grand Theft Auto", - kidnap = "Kidnap", - assassination = "Assassination", - heist = "Heist", -} - -/** - * Corporation division - * @public - */ -export declare interface Division { - /** Name of the division */ - name: string; - /** Type of division, like Agriculture */ - type: CorpIndustryName; - /** Awareness of the division */ - awareness: number; - /** Popularity of the division */ - popularity: number; - /** Production multiplier */ - prodMult: number; - /** Amount of research in that division */ - research: number; - /** Revenue last cycle */ - lastCycleRevenue: number; - /** Expenses last cycle */ - lastCycleExpenses: number; - /** Revenue this cycle */ - thisCycleRevenue: number; - /** Expenses this cycle */ - thisCycleExpenses: number; - /** All research bought */ - upgrades: number[]; - /** Cities in which this division has expanded */ - cities: CityName[]; - /** Products developed by this division */ - products: string[]; - /** Whether the industry this division is in is capable of making products */ - makesProducts: boolean; -} - -/** - * Object representing data representing a gang member equipment. - * @public - */ -export declare interface EquipmentStats { - /** Strength multiplier */ - str?: number; - /** Defense multiplier */ - def?: number; - /** Dexterity multiplier */ - dex?: number; - /** Agility multiplier */ - agi?: number; - /** Charisma multiplier */ - cha?: number; - /** Hacking multiplier */ - hack?: number; -} - -/** - * Export order for a material - * @public - */ -export declare interface Export { - /** Division the material is being exported to */ - div: string; - /** City the material is being exported to */ - loc: CityName; - /** Amount of material exported */ - amt: string; -} - -/** @public */ -export declare enum FactionWorkType { - hacking = "hacking", - field = "field", - security = "security", -} - -/** @public */ -export declare type FilenameOrPID = number | string; - -/** - * Formulas API - * @remarks - * You need Formulas.exe on your home computer to use this API. - * @public - */ -export declare interface Formulas { - mockServer(): Server; - mockPlayer(): Player; - mockPerson(): Person; - /** Reputation formulas */ - reputation: ReputationFormulas; - /** Skills formulas */ - skills: SkillsFormulas; - /** Hacking formulas */ - hacking: HackingFormulas; - /** Hacknet Nodes formulas */ - hacknetNodes: HacknetNodesFormulas; - /** Hacknet Servers formulas */ - hacknetServers: HacknetServersFormulas; - /** Gang formulas */ - gang: GangFormulas; - /** Work formulas */ - work: WorkFormulas; -} - -/** @public */ -export declare interface Fragment { - id: number; - shape: boolean[][]; - type: number; - power: number; - limit: number; -} - -/** - * Game Information - * @public - */ -export declare interface GameInfo { - version: string; - commit: string; - platform: string; -} - -/** - * Gang API - * @remarks - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this API. - * @public - */ -export declare interface Gang { - /** - * Create a gang. - * @remarks - * RAM cost: 1GB - * - * Create a gang with the specified faction. - * @returns True if the gang was created, false otherwise. - */ - createGang(faction: string): boolean; - - /** - * Check if you're in a gang. - * @remarks - * RAM cost: 1GB - * @returns True if you're in a gang, false otherwise. - */ - inGang(): boolean; - - /** - * List all gang members. - * @remarks - * RAM cost: 1 GB - * - * Get the names of all Gang members - * - * @returns Names of all Gang members. - */ - getMemberNames(): string[]; - - /** - * Get information about your gang. - * @remarks - * RAM cost: 2 GB - * - * Get general information about the gang. - * - * @returns Object containing general information about the gang. - */ - getGangInformation(): GangGenInfo; - - /** - * Get information about the other gangs. - * @remarks - * RAM cost: 2 GB - * - * Get territory and power information about all gangs. - * - * @returns Object containing territory and power information about all gangs. - */ - getOtherGangInformation(): GangOtherInfo; - - /** - * Get information about a specific gang member. - * @remarks - * RAM cost: 2 GB - * - * Get stat and equipment-related information about a Gang Member - * - * @param name - Name of member. - * @returns Object containing stat and equipment-related information about a Gang Member. - */ - getMemberInformation(name: string): GangMemberInfo; - - /** - * Check if you can recruit a new gang member. - * @remarks - * RAM cost: 1 GB - * - * Returns a boolean indicating whether a member can currently be recruited. - * - * Once you have successfully created a gang by using the function - * {@link Gang.createGang | createGang}, you can immediately recruit a small - * number of members to your gang. After you have recruited the founding - * members, to recruit another member you must increase your respect. The - * more members you want to recruit, the more respect you require. If your - * gang has the maximum number of members, then this function would return - * false. - * - * @returns True if a member can currently be recruited, false otherwise. - */ - canRecruitMember(): boolean; - - /** - * Recruit a new gang member. - * @remarks - * RAM cost: 2 GB - * - * 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 - * - * @param name - Name of member to recruit. - * @returns True if the member was successfully recruited, false otherwise. - */ - recruitMember(name: string): boolean; - - /** - * List member task names. - * @remarks - * RAM cost: 1 GB - * - * Get the name of all valid tasks that Gang members can be assigned to. - * - * @returns All valid tasks that Gang members can be assigned to. - */ - getTaskNames(): string[]; - - /** - * Set gang member to task. - * @remarks - * RAM cost: 2 GB - * - * 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”). - * - * @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: string): boolean; - - /** - * Get stats of a task. - * @remarks - * RAM cost: 1 GB - * - * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. - * - * @param name - Name of the task. - * @returns Detailed stats of a task. - */ - getTaskStats(name: string): GangTaskStats; - - /** - * List equipment names. - * @remarks - * RAM cost: 1 GB - * - * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. - * This includes Augmentations. - * - * @returns Names of all Equipments/Augmentations. - */ - getEquipmentNames(): string[]; - - /** - * Get cost of equipment. - * @remarks - * RAM cost: 2 GB - * - * 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. - * - * @param equipName - Name of equipment. - * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments - */ - getEquipmentCost(equipName: string): number; - - /** - * Get type of an equipment. - * @remarks - * RAM cost: 2 GB - * - * Get the specified equipment type. - * - * @param equipName - Name of equipment. - * @returns Type of the equipment. - */ - getEquipmentType(equipName: string): string; - - /** - * Get stats of an equipment. - * @remarks - * RAM cost: 2 GB - * - * Get the specified equipment stats. - * - * @param equipName - Name of equipment. - * @returns A dictionary containing the stats of the equipment. - */ - getEquipmentStats(equipName: string): EquipmentStats; - - /** - * Purchase an equipment for a gang member. - * @remarks - * RAM cost: 4 GB - * - * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. - * - * @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: string): boolean; - - /** - * Ascend a gang member. - * @remarks - * RAM cost: 4 GB - * - * Ascend the specified Gang Member. - * - * @param memberName - Name of member to ascend. - * @returns Object with info about the ascension results. Undefined if ascension did not occur. - */ - ascendMember(memberName: string): GangMemberAscension | undefined; - - /** - * Get the result of an ascension without ascending. - * @remarks - * RAM cost: 2 GB - * - * Get the result of an ascension without ascending. - * - * @param memberName - Name of member. - * @returns Object with info about the ascension results. Undefined if ascension is impossible. - */ - getAscensionResult(memberName: string): GangMemberAscension | undefined; - - /** - * Enable/Disable territory warfare. - * @remarks - * RAM cost: 2 GB - * - * Set whether or not the gang should engage in territory warfare - * - * @param engage - Whether or not to engage in territory warfare. - */ - setTerritoryWarfare(engage: boolean): void; - - /** - * Get chance to win clash with other gang. - * @remarks - * RAM cost: 4 GB - * - * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage - * - * @param gangName - Target gang - * @returns Chance you have to win a clash with the specified gang. - */ - getChanceToWinClash(gangName: string): number; - - /** - * Get bonus time. - * @remarks - * RAM cost: 0 GB - * - * Returns the amount of accumulated “bonus time” (milliseconds) for the Gang mechanic. - * - * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. - * - * “Bonus time” makes the game progress faster, up to 10x the normal speed. - * - * @returns Bonus time for the Gang mechanic in milliseconds. - */ - getBonusTime(): number; -} - -/** - * Gang formulas - * @public - */ -export declare interface GangFormulas { - /** - * Calculate the wanted penalty. - * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} - * @returns The calculated wanted penalty. - */ - wantedPenalty(gang: GangGenInfo): number; - /** - * Calculate respect gain per tick. - * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} - * @param member - Gang info from {@link Gang.getMemberInformation | getMemberInformation} - * @param task - Gang info from {@link Gang.getTaskStats | getTaskStats} - * @returns The calculated respect gain. - */ - respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; - /** - * Calculate wanted gain per tick. - * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} - * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation} - * @param task - Task info from {@link Gang.getTaskStats | getTaskStats} - * @returns The calculated wanted gain. - */ - wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; - /** - * Calculate money gain per tick. - * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} - * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation} - * @param task - Task info from {@link Gang.getTaskStats | getTaskStats} - * @returns The calculated money gain. - */ - moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; - - /** - * Calculate ascension point gain. - * @param exp - Experience point before ascension. - * @returns The calculated ascension point gain. - */ - ascensionPointsGain(exp: number): number; - - /** - * Calculate ascension mult. - * @param points - Amount of ascension points. - * @returns The calculated ascension mult. - */ - ascensionMultiplier(points: number): number; -} - -/** - * Gang general info. - * @public - */ -export declare interface GangGenInfo { - /** Name of faction that the gang belongs to ("Slum Snakes", etc.) */ - faction: string; - /** Indicating whether or not it's a hacking gang */ - isHacking: boolean; - /** Money earned per game cycle */ - moneyGainRate: number; - /** Gang's power for territory warfare */ - power: number; - /** Gang's respect */ - respect: number; - /** Respect earned per game cycle */ - respectGainRate: number; - /** Amount of territory held */ - territory: number; - /** Clash chance */ - territoryClashChance: number; - /** Gang's wanted level */ - wantedLevel: number; - /** Wanted level gained/lost per game cycle (negative for losses) */ - wantedLevelGainRate: number; - /** Indicating if territory warfare is enabled */ - territoryWarfareEngaged: boolean; - /** Number indicating the current wanted penalty */ - wantedPenalty: number; -} - -/** @public */ -export declare interface GangMemberAscension { - /** Amount of respect lost from ascending */ - respect: number; - /** Hacking multiplier gained from ascending */ - hack: number; - /** Strength multiplier gained from ascending */ - str: number; - /** Defense multiplier gained from ascending */ - def: number; - /** Dexterity multiplier gained from ascending */ - dex: number; - /** Agility multiplier gained from ascending */ - agi: number; - /** Charisma multiplier gained from ascending */ - cha: number; -} - -/** @public */ -export declare interface GangMemberInfo { - /** Name of the gang member */ - name: string; - /** Currently assigned task */ - task: string; - earnedRespect: number; - - /** Hack skill level */ - hack: number; - /** Strength skill level */ - str: number; - /** Defense skill level */ - def: number; - /** Dexterity skill level */ - dex: number; - /** Agility skill level */ - agi: number; - /** Charisma skill level */ - cha: number; - - /** Current hack experience */ - hack_exp: number; - /** Current strength experience */ - str_exp: number; - /** Current defense experience */ - def_exp: number; - /** Current dexterity experience */ - dex_exp: number; - /** Current agility experience */ - agi_exp: number; - /** Current charisma experience */ - cha_exp: number; - - /** Hack multiplier from equipment */ - hack_mult: number; - /** Strength multiplier from equipment */ - str_mult: number; - /** Defense multiplier from equipment */ - def_mult: number; - /** Dexterity multiplier from equipment */ - dex_mult: number; - /** Agility multiplier from equipment */ - agi_mult: number; - /** Charisma multiplier from equipment */ - cha_mult: number; - - /** Hack multiplier from ascensions */ - hack_asc_mult: number; - /** Strength multiplier from ascensions */ - str_asc_mult: number; - /** Defense multiplier from ascensions */ - def_asc_mult: number; - /** Dexterity multiplier from ascensions */ - dex_asc_mult: number; - /** Agility multiplier from ascensions */ - agi_asc_mult: number; - /** Charisma multiplier from ascensions */ - cha_asc_mult: number; - - /** Total earned hack experience */ - hack_asc_points: number; - /** Total earned strength experience */ - str_asc_points: number; - /** Total earned defense experience */ - def_asc_points: number; - /** Total earned dexterity experience */ - dex_asc_points: number; - /** Total earned agility experience */ - agi_asc_points: number; - /** Total earned charisma experience */ - cha_asc_points: number; - - upgrades: string[]; - augmentations: string[]; - - respectGain: number; - wantedLevelGain: number; - moneyGain: number; -} - -/** @public */ -export declare interface GangOtherInfo { - [key: string]: GangOtherInfoObject; -} - -/** @public */ -export declare interface GangOtherInfoObject { - /** Gang power */ - power: number; - /** Gang territory, in decimal form */ - territory: number; -} - -/** - * Object representing data representing a gang member task. - * @public - */ -export declare interface GangTaskStats { - /** Task name */ - name: string; - /** 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; - /** Strength 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: GangTerritory; -} - -/** @public */ -export declare interface GangTerritory { - /** Money gain impact on task scaling */ - money: number; - /** Respect gain impact on task scaling */ - respect: number; - /** Wanted gain impact on task scaling */ - wanted: number; -} - -/** - * Grafting API - * @remarks - * This API requires Source-File 10 to use. - * @public - */ -export declare interface Grafting { - /** - * Retrieve the grafting cost of an aug. - * @remarks - * RAM cost: 3.75 GB - * - * @param augName - Name of the aug to check the price of. Must be an exact match. - * @returns The cost required to graft the named augmentation. - * @throws Will error if an invalid Augmentation name is provided. - */ - getAugmentationGraftPrice(augName: string): number; - - /** - * Retrieves the time required to graft an aug. - * @remarks - * RAM cost: 3.75 GB - * - * @param augName - Name of the aug to check the grafting time of. Must be an exact match. - * @returns The time required, in millis, to graft the named augmentation. - * @throws Will error if an invalid Augmentation name is provided. - */ - getAugmentationGraftTime(augName: string): number; - - /** - * Retrieves a list of Augmentations that can be grafted. - * @remarks - * RAM cost: 5 GB - * - * Note that this function returns a list of currently graftable Augmentations, - * based off of the Augmentations that you already own. - * - * @returns An array of graftable Augmentations. - */ - getGraftableAugmentations(): string[]; - - /** - * Begins grafting the named aug. You must be in New Tokyo to use this. - * @remarks - * RAM cost: 7.5 GB - * - * @param augName - The name of the aug to begin grafting. Must be an exact match. - * @param focus - Acquire player focus on this Augmentation grafting. Optional. Defaults to true. - * @returns True if the aug successfully began grafting, false otherwise (e.g. not enough money, or - * invalid Augmentation name provided). - * @throws Will error if called while you are not in New Tokyo. - */ - graftAugmentation(augName: string, focus?: boolean): boolean; -} - -/** @public */ -export declare enum GymType { - strength = "str", - defense = "def", - dexterity = "dex", - agility = "agi", -} - -/** - * Hacking formulas - * @public - */ -export declare interface HackingFormulas { - /** - * Calculate hack chance. - * (Ex: 0.25 would indicate a 25% chance of success.) - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated hack chance. - */ - hackChance(server: Server, player: Person): number; - /** - * Calculate hack exp for one thread. - * @remarks - * Multiply by thread to get total exp - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated hack exp. - */ - hackExp(server: Server, player: Person): number; - /** - * Calculate hack percent for one thread. - * (Ex: 0.25 would steal 25% of the server's current value.) - * @remarks - * Multiply by thread to get total percent hacked. - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated hack percent. - */ - hackPercent(server: Server, player: Person): number; - /** - * Calculate the percent a server would grow to. - * Not exact due to limitations of mathematics. - * (Ex: 3.0 would would grow the server to 300% of its current value.) - * @param server - Server info from {@link NS.getServer | getServer} - * @param threads - Amount of thread. - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @param cores - Number of cores on the computer that will execute grow. - * @returns The calculated grow percent. - */ - growPercent(server: Server, threads: number, player: Person, cores?: number): number; - /** - * Calculate hack time. - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated hack time. - */ - hackTime(server: Server, player: Person): number; - /** - * Calculate grow time. - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated grow time. - */ - growTime(server: Server, player: Person): number; - /** - * Calculate weaken time. - * @param server - Server info from {@link NS.getServer | getServer} - * @param player - Player info from {@link NS.getPlayer | getPlayer} - * @returns The calculated weaken time. - */ - weakenTime(server: Server, player: Person): number; -} - -/** - * Hack related multipliers. - * @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; -} - -/** - * Hacknet API - * @remarks - * Not all these functions are immediately available. - * @public - */ -export declare interface Hacknet { - /** - * Get the number of hacknet nodes you own. - * @remarks - * RAM cost: 0 GB - * - * Returns the number of Hacknet Nodes you own. - * - * @returns Number of hacknet nodes. - */ - numNodes(): number; - - /** - * Get the maximum number of hacknet nodes. - * @remarks - * RAM cost: 0 GB - * - * @returns Maximum number of hacknet nodes. - */ - maxNumNodes(): number; - - /** - * Purchase a new hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Get the price of the next hacknet node. - * @remarks - * RAM cost: 0 GB - * - * Returns the cost of purchasing a new Hacknet Node. - * - * @returns Cost of purchasing a new Hacknet Node. - */ - getPurchaseNodeCost(): number; - - /** - * Get the stats of a hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @param index - Index/Identifier of Hacknet Node - * @returns Object containing a variety of stats about the specified Hacknet Node. - */ - getNodeStats(index: number): NodeStats; - - /** - * Upgrade the level of a hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Upgrade the RAM of a hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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 its max RAM. - * - * Returns false otherwise. - * - * @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; - - /** - * Upgrade the core of a hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Upgrade the cache of a hacknet node. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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 cache level is successfully upgraded, false otherwise. - */ - upgradeCache(index: number, n: number): boolean; - - /** - * Calculate the cost of upgrading hacknet node levels. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Calculate the cost of upgrading hacknet node RAM. - * @remarks - * RAM cost: 0 GB - * - * 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 already has max RAM, then Infinity is returned. - * - * @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; - - /** - * Calculate the cost of upgrading hacknet node cores. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Calculate the cost of upgrading hacknet node cache. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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; - - /** - * Get the total number of hashes stored. - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * Returns the number of hashes you have. - * - * @returns Number of hashes you have. - */ - numHashes(): number; - - /** - * Get the maximum number of hashes you can store. - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * Returns the number of hashes you can store. - * - * @returns Number of hashes you can store. - */ - hashCapacity(): number; - - /** - * Get the cost of a hash upgrade. - * @remarks - * RAM cost: 0 GB - * - * 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 - * ```ts - * // NS1: - * var upgradeName = "Sell for Corporation Funds"; - * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) { - * hacknet.spendHashes(upgradeName); - * } - * ``` - * @example - * ```ts - * // NS2: - * const upgradeName = "Sell for Corporation Funds"; - * if (ns.hacknet.numHashes() > ns.hacknet.hashCost(upgradeName)) { - * ns.hacknet.spendHashes(upgradeName); - * } - * ``` - * @param upgName - Name of the upgrade of Hacknet Node. - * @param count - Number of upgrades to buy at once. Defaults to 1 if not specified. - * @returns Number of hashes required for the specified upgrade. - */ - hashCost(upgName: string, count?: number): number; - - /** - * Purchase a hash upgrade. - * @remarks - * RAM cost: 0 GB - * - * 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 - * ```ts - * // NS1: - * hacknet.spendHashes("Sell for Corporation Funds"); - * hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); - * ``` - * @example - * ```ts - * NS2: - * ns.hacknet.spendHashes("Sell for Corporation Funds"); - * ns.hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); - * ``` - * @param upgName - Name of the upgrade of Hacknet Node. - * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. - * @param count - Number of upgrades to buy at once. Defaults to 1 if not specified. - * For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. - * @returns True if the upgrade is successfully purchased, and false otherwise. - */ - spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; - - /** - * Get the list of hash upgrades - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * Returns the list of all available hash upgrades that can be used in the spendHashes function. - * @example - * ```ts - * // NS1: - * var upgrades = hacknet.getHashUpgrades(); // ["Sell for Money","Sell for Corporation Funds",...] - * ``` - * @example - * ```ts - * // NS2: - * const upgrades = ns.hacknet.getHashUpgrades(); // ["Sell for Money","Sell for Corporation Funds",...] - * ``` - * @returns An array containing the available upgrades - */ - getHashUpgrades(): string[]; - - /** - * Get the level of a hash upgrade. - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * @returns Level of the upgrade. - */ - getHashUpgradeLevel(upgName: string): number; - - /** - * Get the multiplier to study. - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * @returns Multiplier. - */ - getStudyMult(): number; - - /** - * Get the multiplier to training. - * @remarks - * RAM cost: 0 GB - * - * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - * - * @returns Multiplier. - */ - getTrainingMult(): number; -} - -/** - * Hacknet related multipliers. - * @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; -} - -/** - * Hacknet node related constants - * @public - */ -export declare interface HacknetNodeConstants { - /** Amount of money gained per level */ - MoneyGainPerLevel: number; - /** Base cost for a new node */ - BaseCost: number; - /** Base cost per level */ - LevelBaseCost: number; - /** Base cost to increase RAM */ - RamBaseCost: number; - /** Base cost to increase cores */ - CoreBaseCost: number; - /** Multiplier to purchase new node */ - PurchaseNextMult: number; - /** Multiplier to increase node level */ - UpgradeLevelMult: number; - /** Multiplier to increase RAM */ - UpgradeRamMult: number; - /** Multiplier to increase cores */ - UpgradeCoreMult: number; - /** Max node level */ - MaxLevel: number; - /** Max amount of RAM in GB */ - MaxRam: number; - /** Max number of cores */ - MaxCores: number; -} - -/** - * Hacknet Node formulas - * @public - */ -export declare interface HacknetNodesFormulas { - /** - * Calculate money gain rate. - * @param level - level of the node. - * @param ram - ram of the node. - * @param cores - cores of the node. - * @param mult - player production mult (default to 1) - * @returns The calculated money gain rate. - */ - moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; - /** - * Calculate cost of upgrading hacknet node level. - * @param startingLevel - starting level - * @param extraLevels - amount of level to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; - /** - * Calculate cost of upgrading hacknet node ram. - * @param startingRam - starting ram - * @param extraLevels - amount of level of ram to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; - /** - * Calculate cost of upgrading hacknet node cores. - * @param startingCore - starting cores - * @param extraCores - amount of cores to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; - /** - * Calculate the cost of a hacknet node. - * @param n - number of the hacknet node - * @param mult - player cost reduction (defaults to 1) - * @returns The calculated cost. - */ - hacknetNodeCost(n: number, mult: number): number; - /** - * All constants used by the game. - * @returns An object with all hacknet node constants used by the game. - */ - constants(): HacknetNodeConstants; -} - -/** - * Hacknet server related constants - * @public - */ -export declare interface HacknetServerConstants { - /** Number of hashes calculated per level */ - HashesPerLevel: number; - /** Base cost for a new server */ - BaseCost: number; - /** Base cost to increase RAM */ - RamBaseCost: number; - /** Base cost to increase cores */ - CoreBaseCost: number; - /** Base cost to upgrade cache */ - CacheBaseCost: number; - /** Multiplier to purchase a new server */ - PurchaseMult: number; - /** Multiplier to increase server level */ - UpgradeLevelMult: number; - /** Multiplier to increase RAM */ - UpgradeRamMult: number; - /** Multiplier to increase cores */ - UpgradeCoreMult: number; - /** Multiplier to upgrade cache */ - UpgradeCacheMult: number; - /** Max number of servers */ - MaxServers: number; - /** Max level for a server */ - MaxLevel: number; - /** Max amount of RAM in GB */ - MaxRam: number; - /** Max number of cores */ - MaxCores: number; - /** Max cache size */ - MaxCache: number; -} - -/** - * Hacknet Server formulas - * @public - */ -export declare interface HacknetServersFormulas { - /** - * Calculate hash gain rate. - * @param level - level of the server. - * @param ramUsed - ramUsed of the server. - * @param maxRam - maxRam of the server. - * @param cores - cores of the server. - * @param mult - player production mult (default to 1) - * @returns The calculated hash gain rate. - */ - hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number; - /** - * Calculate cost of upgrading hacknet server level. - * @param startingLevel - starting level - * @param extraLevels - amount of level to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; - /** - * Calculate cost of upgrading hacknet server ram. - * @param startingRam - starting ram - * @param extraLevels - amount of level of ram to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; - /** - * Calculate cost of upgrading hacknet server cores. - * @param startingCore - starting cores - * @param extraCores - amount of cores to purchase (defaults to 1) - * @param costMult - player cost reduction (default to 1) - * @returns The calculated cost. - */ - coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; - /** - * Calculate cost of upgrading hacknet server cache. - * @param startingCache - starting cache level - * @param extraCache - amount of levels of cache to purchase (defaults to 1) - * @returns The calculated cost. - */ - cacheUpgradeCost(startingCache: number, extraCache?: number): number; - /** - * Calculate hash cost of an upgrade. - * @param upgName - name of the upgrade - * @param level - level of the upgrade - * @returns The calculated hash cost. - */ - hashUpgradeCost(upgName: number, level: number): number; - /** - * Calculate the cost of a hacknet server. - * @param n - number of the hacknet server - * @param mult - player cost reduction (defaults to 1) - * @returns The calculated cost. - */ - hacknetServerCost(n: number, mult?: number): number; - /** - * All constants used by the game. - * @returns An object with all hacknet server constants used by the game. - */ - constants(): HacknetServerConstants; -} - -/** @public */ -export declare interface HP { - current: number; - max: number; -} - -/** @public */ -export declare interface ILocation { - city: CityName; - name: LocationName; -} - -/** - * Corporation industry information - * @public - */ -export declare interface IndustryData { - /** Industry type */ - type: CorpIndustryName; - /** Cost to expand to the division */ - cost: number; - /** Materials required for production and their amounts */ - requiredMaterials: Record; - /** Materials produced */ - producedMaterials?: string[]; - /** Whether the division makes materials */ - makesMaterials: boolean; - /** Whether the division makes products */ - makesProducts: boolean; - /** Product type */ - productType?: string; -} - -/** - * Infiltration API. - * @public - */ -export declare interface Infiltration { - /** - * Get all locations that can be infiltrated. - * @remarks - * RAM cost: 5 GB - * - * @returns all locations that can be infiltrated. - */ - getPossibleLocations(): ILocation[]; - /** - * Get all infiltrations with difficulty, location and rewards. - * @remarks - * RAM cost: 15 GB - * - * @returns Infiltration data for given location. - */ - getInfiltration(location: string): InfiltrationLocation; -} - -/** @public */ -export declare interface InfiltrationLocation { - location: ILocation; - reward: InfiltrationReward; - difficulty: number; -} - -/** @public */ -export declare interface InfiltrationReward { - tradeRep: number; - sellCash: number; - SoARep: number; -} - -/** - * Corporation investment offer - * @public - */ -export declare interface InvestmentOffer { - /** Amount of funds you will get from this investment */ - funds: number; - /** Amount of share you will give in exchange for this investment */ - shares: number; - /** Current round of funding (max 4) */ - round: number; -} - -/** - * Interface Styles - * @public - */ -export declare interface IStyleSettings { - fontFamily: string; - lineHeight: number; -} - -/** @public */ -export declare enum JobName { - software0 = "Software Engineering Intern", - software1 = "Junior Software Engineer", - software2 = "Senior Software Engineer", - software3 = "Lead Software Developer", - software4 = "Head of Software", - software5 = "Head of Engineering", - software6 = "Vice President of Technology", - software7 = "Chief Technology Officer", - IT0 = "IT Intern", - IT1 = "IT Analyst", - IT2 = "IT Manager", - IT3 = "Systems Administrator", - securityEng = "Security Engineer", - networkEng0 = "Network Engineer", - networkEng1 = "Network Administrator", - business0 = "Business Intern", - business1 = "Business Analyst", - business2 = "Business Manager", - business3 = "Operations Manager", - business4 = "Chief Financial Officer", - business5 = "Chief Executive Officer", - security0 = "Police Officer", - security1 = "Police Chief", - security2 = "Security Guard", - security3 = "Security Officer", - security4 = "Security Supervisor", - security5 = "Head of Security", - agent0 = "Field Agent", - agent1 = "Secret Agent", - agent2 = "Special Operative", - waiter = "Waiter", - employee = "Employee", - softwareConsult0 = "Software Consultant", - softwareConsult1 = "Senior Software Consultant", - businessConsult0 = "Business Consultant", - businessConsult1 = "Senior Business Consultant", - waiterPT = "Part-time Waiter", - employeePT = "Part-time Employee", -} - -/** Names of all locations - * @public */ -export declare enum LocationName { - AevumAeroCorp = "AeroCorp", - AevumBachmanAndAssociates = "Bachman & Associates", - AevumClarkeIncorporated = "Clarke Incorporated", - AevumCrushFitnessGym = "Crush Fitness Gym", - AevumECorp = "ECorp", - AevumFulcrumTechnologies = "Fulcrum Technologies", - AevumGalacticCybersystems = "Galactic Cybersystems", - AevumNetLinkTechnologies = "NetLink Technologies", - AevumPolice = "Aevum Police Headquarters", - AevumRhoConstruction = "Rho Construction", - AevumSnapFitnessGym = "Snap Fitness Gym", - AevumSummitUniversity = "Summit University", - AevumWatchdogSecurity = "Watchdog Security", - AevumCasino = "Iker Molina Casino", - - ChongqingKuaiGongInternational = "KuaiGong International", - ChongqingSolarisSpaceSystems = "Solaris Space Systems", - ChongqingChurchOfTheMachineGod = "Church of the Machine God", - - Sector12AlphaEnterprises = "Alpha Enterprises", - Sector12BladeIndustries = "Blade Industries", - Sector12CIA = "Central Intelligence Agency", - Sector12CarmichaelSecurity = "Carmichael Security", - Sector12CityHall = "Sector-12 City Hall", - Sector12DeltaOne = "DeltaOne", - Sector12FoodNStuff = "FoodNStuff", - Sector12FourSigma = "Four Sigma", - Sector12IcarusMicrosystems = "Icarus Microsystems", - Sector12IronGym = "Iron Gym", - Sector12JoesGuns = "Joe's Guns", - Sector12MegaCorp = "MegaCorp", - Sector12NSA = "National Security Agency", - Sector12PowerhouseGym = "Powerhouse Gym", - Sector12RothmanUniversity = "Rothman University", - Sector12UniversalEnergy = "Universal Energy", - - NewTokyoDefComm = "DefComm", - NewTokyoGlobalPharmaceuticals = "Global Pharmaceuticals", - NewTokyoNoodleBar = "Noodle Bar", - NewTokyoVitaLife = "VitaLife", - NewTokyoArcade = "Arcade", - - IshimaNovaMedical = "Nova Medical", - IshimaOmegaSoftware = "Omega Software", - IshimaStormTechnologies = "Storm Technologies", - IshimaGlitch = "0x6C1", - - VolhavenCompuTek = "CompuTek", - VolhavenHeliosLabs = "Helios Labs", - VolhavenLexoCorp = "LexoCorp", - VolhavenMilleniumFitnessGym = "Millenium Fitness Gym", - VolhavenNWO = "NWO", - VolhavenOmniTekIncorporated = "OmniTek Incorporated", - VolhavenOmniaCybersystems = "Omnia Cybersystems", - VolhavenSysCoreSecurities = "SysCore Securities", - VolhavenZBInstituteOfTechnology = "ZB Institute of Technology", - - Hospital = "Hospital", - Slums = "The Slums", - TravelAgency = "Travel Agency", - WorldStockExchange = "World Stock Exchange", - - Void = "The Void", -} - -/** - * Material in a warehouse - * @public - */ -export declare interface Material { - /** Name of the material */ - name: CorpMaterialName; - /** Amount of material */ - qty: number; - /** Quality of the material */ - qlt: number; - /** Demand for the material, only present if "Market Research - Demand" unlocked */ - dmd: number | undefined; - /** Competition for the material, only present if "Market Research - Competition" unlocked */ - cmp: number | undefined; - /** Amount of material produced */ - prod: number; - /** Amount of material sold */ - sell: number; - /** Cost to buy material */ - cost: number; - /** Sell cost, can be "MP+5" */ - sCost: string | number; - /** Export orders */ - exp: Export[]; -} - -/** @public */ -export declare interface MoneySource { - bladeburner: number; - casino: number; - class: number; - codingcontract: number; - corporation: number; - crime: number; - gang: number; - hacking: number; - hacknet: number; - hacknet_expenses: number; - hospitalization: number; - infiltration: number; - sleeves: number; - stock: number; - total: number; - work: number; - servers: number; - other: number; - augmentations: number; -} - -/** @public */ -export declare interface MoneySources { - sinceInstall: MoneySource; - sinceStart: MoneySource; -} - -/** @public */ -export declare interface Multipliers { - /** Multiplier to hacking skill */ - hacking: number; - /** Multiplier to strength skill */ - strength: number; - /** Multiplier to defense skill */ - defense: number; - /** Multiplier to dexterity skill */ - dexterity: number; - /** Multiplier to agility skill */ - agility: number; - /** Multiplier to charisma skill */ - charisma: number; - /** Multiplier to hacking experience gain rate */ - hacking_exp: number; - /** Multiplier to strength experience gain rate */ - strength_exp: number; - /** Multiplier to defense experience gain rate */ - defense_exp: number; - /** Multiplier to dexterity experience gain rate */ - dexterity_exp: number; - /** Multiplier to agility experience gain rate */ - agility_exp: number; - /** Multiplier to charisma experience gain rate */ - charisma_exp: number; - /** Multiplier to chance of successfully performing a hack */ - hacking_chance: number; - /** Multiplier to hacking speed */ - hacking_speed: number; - /** Multiplier to amount of money the player gains from hacking */ - hacking_money: number; - /** Multiplier to amount of money injected into servers using grow */ - hacking_grow: number; - /** Multiplier to amount of reputation gained when working */ - company_rep: number; - /** Multiplier to amount of reputation gained when working */ - faction_rep: number; - /** Multiplier to amount of money gained from crimes */ - crime_money: number; - /** Multiplier to crime success rate */ - crime_success: number; - /** Multiplier to amount of money gained from working */ - work_money: number; - /** Multiplier to amount of money produced by Hacknet Nodes */ - hacknet_node_money: number; - /** Multiplier to cost of purchasing a Hacknet Node */ - hacknet_node_purchase_cost: number; - /** Multiplier to cost of ram for a Hacknet Node */ - hacknet_node_ram_cost: number; - /** Multiplier to cost of core for a Hacknet Node */ - hacknet_node_core_cost: number; - /** Multiplier to cost of leveling up a Hacknet Node */ - hacknet_node_level_cost: number; - /** Multiplier to Bladeburner max stamina */ - bladeburner_max_stamina: number; - /** Multiplier to Bladeburner stamina gain rate */ - bladeburner_stamina_gain: number; - /** Multiplier to effectiveness in Bladeburner Field Analysis */ - bladeburner_analysis: number; - /** Multiplier to success chance in Bladeburner contracts/operations */ - bladeburner_success_chance: number; -} - -/** Object representing a port. A port is a serialized queue. - * @public */ -export declare interface NetscriptPort { - /** Write data to a port. - * @remarks - * RAM cost: 0 GB - * - * @returns The data popped off the queue if it was full. */ - write(value: string | number): PortData | null; - - /** - * Attempt to write data to the port. - * @remarks - * RAM cost: 0 GB - * - * @returns True if the data was added to the port, false if the port was full - */ - tryWrite(value: string | number): boolean; - - /** - * Sleeps until the port is written to. - * @remarks - * RAM cost: 0 GB - */ - nextWrite(): Promise; - - /** - * Shift an element out of the port. - * @remarks - * RAM cost: 0 GB - * - * This function will remove the first element from the port and return it. - * If the port is empty, then the string “NULL PORT DATA” will be returned. - * @returns the data read. - */ - read(): PortData; - - /** - * Retrieve the first element from the port without removing it. - * @remarks - * RAM cost: 0 GB - * - * 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. - * @returns the data read - */ - peek(): PortData; - - /** - * Check if the port is full. - * @remarks - * RAM cost: 0 GB - * - * @returns true if the port is full, otherwise false - */ - full(): boolean; - - /** - * Check if the port is empty. - * @remarks - * RAM cost: 0 GB - * - * @returns true if the port is empty, otherwise false - */ - empty(): boolean; - - /** - * Empties all data from the port. - * @remarks - * RAM cost: 0 GB - */ - clear(): void; -} - -/** - * Object representing all the values related to a hacknet node. - * @public - */ -export declare interface NodeStats { - /** Node's name */ - name: string; - /** Node's level */ - level: number; - /** Node's RAM (GB) */ - ram: number; - /** Node's used RAM (GB) */ - ramUsed?: 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; -} - -/** - * Collection of all functions passed to scripts - * @public - * @remarks - * Basic ns1 usage example: - * ```ts - * // Basic ns functions can be used directly - * getHostname(); - * // Some related functions are gathered within a common namespace - * stock.getPrice(); - * ``` - * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} - *
- * Basic ns2 usage example: - * ```ts - * export async function main(ns) { - * // Basic ns functions can be accessed on the ns object - * ns.getHostname(); - * // Some related functions are gathered under a sub-property of the ns object - * ns.stock.getPrice(); - * // Some functions need to be awaited - * await ns.hack('n00dles'); - * } - * ``` - * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} - *
- */ -export declare interface NS { - /** - * Namespace for hacknet functions. - * @remarks RAM cost: 4 GB - */ - readonly hacknet: Hacknet; - - /** - * Namespace for bladeburner functions. - * @remarks RAM cost: 0 GB - */ - readonly bladeburner: Bladeburner; - - /** - * Namespace for codingcontract functions. - * @remarks RAM cost: 0 GB - */ - readonly codingcontract: CodingContract; - - /** - * Namespace for gang functions. - * @remarks RAM cost: 0 GB - */ - readonly gang: Gang; - - /** - * Namespace for sleeve functions. - * @remarks RAM cost: 0 GB - */ - readonly sleeve: Sleeve; - - /** - * Namespace for stock functions. - * @remarks RAM cost: 0 GB - */ - readonly stock: TIX; - - /** - * Namespace for formulas functions. - * @remarks RAM cost: 0 GB - */ - readonly formulas: Formulas; - - /** - * Namespace for stanek functions. - * RAM cost: 0 GB - */ - readonly stanek: Stanek; - - /** - * Namespace for infiltration functions. - * RAM cost: 0 GB - */ - readonly infiltration: Infiltration; - - /** - * Namespace for corporation functions. - * RAM cost: 1022.4 GB - */ - readonly corporation: Corporation; - - /** - * Namespace for user interface functions. - * RAM cost: 0 GB - */ - readonly ui: UserInterface; - - /** - * Namespace for singularity functions. - * RAM cost: 0 GB - */ - readonly singularity: Singularity; - - /** - * Namespace for grafting functions. - * @remarks RAM cost: 0 GB - */ - readonly grafting: Grafting; - - /** - * Arguments passed into the script. - * - * @remarks - * RAM cost: 0 GB - * - * Arguments passed into a script can be accessed as a normal array by using the `[]` operator - * (`args[0]`, `args[1]`, etc...). - * Arguments can be string, number, or boolean. - * Use `args.length` to get the number of arguments that were passed into a script. - * - * @example - * `run example.script 7 text true` - * - * ```js - * // NS1 - example.script - * tprint(args.length) // 3 - * tprint(args[0]); // 7 (number) - * tprint(args[1]); // "text" (string) - * tprint(args[2]); // true (boolean) - * tprint(args[3]); // undefined, because only 3 arguments were provided - * ``` - * - * @example - * `run example.js 7 text true` - * - * ```js - * // NS2 - example.js - * export async function main(ns) { - * ns.tprint(ns.args.length) // 3 - * ns.tprint(ns.args[0]); // 7 (number) - * ns.tprint(ns.args[1]); // "text" (string) - * ns.tprint(ns.args[2]); // true (boolean) - * ns.tprint(ns.args[3]); // undefined, because only 3 arguments were provided - * } - * ``` - */ - readonly args: (string | number | boolean)[]; - - /** The current script's PID */ - readonly pid: number; - - /** - * Steal a server's money. - * @remarks - * RAM cost: 0.1 GB - * - * 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 when this function is called. 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 - * ```ts - * // NS1: - * var earnedMoney = hack("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * let earnedMoney = await ns.hack("foodnstuff"); - * ``` - * @param host - Hostname 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: string, opts?: BasicHGWOptions): Promise; - - /** - * Spoof money in a server's bank account, increasing the amount available. - * @remarks - * RAM cost: 0.15 GB - * - * 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 amount equal to the number of threads used and a certain, fixed percentage of current money on - * the server. 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 {@link NS.getServerGrowth | getServerGrowth} function can be used to obtain a server’s growth rate. - * - * Like {@link NS.hack | 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 - * ```ts - * // NS1: - * var currentMoney = getServerMoneyAvailable("foodnstuff"); - * currentMoney = currentMoney * grow("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * let currentMoney = ns.getServerMoneyAvailable("foodnstuff"); - * currentMoney *= await ns.grow("foodnstuff"); - * ``` - * @param host - Hostname 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: string, opts?: BasicHGWOptions): Promise; - - /** - * Reduce a server's security level. - * @remarks - * RAM cost: 0.15 GB - * - * Use your hacking skills to attack a server’s security, lowering the server’s security level. - * The runtime for this function depends on your hacking level and the target server’s security - * level when this function is called. This function lowers the security level of the target server by 0.05. - * - * Like {@link NS.hack | hack} and {@link NS.grow| grow}, `weaken` can be called on any server, regardless of - * where the script is running. This function requires root access to the target server, but - * there is no required hacking level to run the function. - * - * @example - * ```ts - * // NS1: - * var currentSecurity = getServerSecurityLevel("foodnstuff"); - * currentSecurity = currentSecurity - weaken("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * let currentSecurity = ns.getServerSecurityLevel("foodnstuff"); - * currentSecurity -= await ns.weaken("foodnstuff"); - * ``` - * @param host - Hostname 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: string, opts?: BasicHGWOptions): Promise; - - /** - * Predict the effect of weaken. - * @remarks - * RAM cost: 1 GB - * - * Returns the security decrease that would occur if a weaken with this many threads happened. - * - * @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; - - /** - * Predict the effect of hack. - * @remarks - * RAM cost: 1 GB - * - * 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 - * ```ts - * //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. - * ``` - * @param host - Hostname 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: string, hackAmount: number): number; - - /** - * Get the part of money stolen with a single thread. - * @remarks - * RAM cost: 1 GB - * - * Returns the part of the specified server’s money you will steal with a single thread hack. - * - * @example - * ```ts - * // NS1: - * //For example, assume the following returns 0.01: - * var hackAmount = hackAnalyze("foodnstuff"); - * //This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money. - * ``` - * @example - * ```ts - * // NS2: - * //For example, assume the following returns 0.01: - * const hackAmount = ns.hackAnalyze("foodnstuff"); - * //This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money. - * ``` - * @param host - Hostname of the target server. - * @returns The part of money you will steal from the target server with a single thread hack. - */ - hackAnalyze(host: string): number; - - /** - * Get the security increase for a number of threads. - * @remarks - * RAM cost: 1 GB - * - * Returns the security increase that would occur if a hack with this many threads happened. - * - * @param threads - Amount of threads that will be used. - * @param hostname - Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. - * @returns The security increase. - */ - hackAnalyzeSecurity(threads: number, hostname?: string): number; - - /** - * Get the chance of successfully hacking a server. - * @remarks - * RAM cost: 1 GB - * - * Returns the chance you have of successfully hacking the specified server. - * - * This returned value is in decimal form, not percentage. - * - * @param host - Hostname of the target server. - * @returns The chance you have of successfully hacking the target server. - */ - hackAnalyzeChance(host: string): number; - - /** - * Calculate the number of grow threads needed to grow a server by a certain multiplier. - * @remarks - * RAM cost: 1 GB - * - * 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. - * - * Due to limitations of mathematics, this function won't be the true value, but an approximation. - * - * Warning: The value returned by this function isn’t necessarily a whole number. - * - * @example - * ```ts - * // NS1: - * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: - * var growTimes = 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). - * ``` - * @example - * ```ts - * // NS2: - * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: - * const growTimes = ns.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). - * ``` - * @param host - Hostname 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: string, growthAmount: number, cores?: number): number; - - /** - * Calculate the security increase for a number of threads. - * @remarks - * RAM cost: 1 GB - * - * Returns the security increase that would occur if a grow with this many threads happened. - * - * @param threads - Amount of threads that will be used. - * @param hostname - Optional. Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. - * @param cores - Optional. The number of cores of the server that would run grow. - * @returns The security increase. - */ - growthAnalyzeSecurity(threads: number, hostname?: string, cores?: number): number; - - /** - * Suspends the script for n milliseconds. - * @remarks - * RAM cost: 0 GB - * - * @param millis - Number of milliseconds to sleep. - * @example - * ```ts - * // NS1: - * // This will count from 1 to 10 in your terminal, with one number every 5 seconds - * for (var i=0; i<10; i++) { - * tprint(i + 1); - * sleep(5000); - * } - * ``` - * @example - * ```ts - * // NS2: - * // This will count from 1 to 10 in your terminal, with one number every 5 seconds - * for (var i=0; i<10; i++) { - * ns.tprint(i + 1); - * await ns.sleep(5000); - * } - * ``` - * @returns - */ - sleep(millis: number): Promise; - - /** - * Suspends the script for n milliseconds. Doesn't block with concurrent calls. - * You should prefer 'sleep' over 'asleep' except when doing very complex UI work. - * @remarks - * RAM cost: 0 GB - * - * @param millis - Number of milliseconds to sleep. - * @returns - */ - asleep(millis: number): Promise; - - /** - * Prints one or more values or variables to the script’s logs. - * @remarks - * RAM cost: 0 GB - * - * If the argument is a string, you can color code your message by prefixing your - * string with one of these strings: - * - * - `"ERROR"`: The whole string will be printed in red. Use this prefix to indicate - * that an error has occurred. - * - * - `"SUCCESS"`: The whole string will be printed in green, similar to the default - * theme of the Terminal. Use this prefix to indicate that something is correct. - * - * - `"WARN"`: The whole string will be printed in yellow. Use this prefix to - * indicate that you or a user of your script should be careful of something. - * - * - `"INFO"`: The whole string will be printed in purplish blue. Use this prefix to - * remind yourself or a user of your script of something. Think of this prefix as - * indicating an FYI (for your information). - * - * For custom coloring, use ANSI escape sequences. The examples below use the Unicode - * escape code `\u001b`. The color coding also works if `\u001b` is replaced with - * the hexadecimal escape code `\x1b`. The Bash escape code `\e` is not supported. - * The octal escape code `\033` is not allowed because the game runs JavaScript in - * strict mode. - * - * @example - * ```ts - * // NS1 - * // Default color coding. - * print("ERROR means something's wrong."); - * print("SUCCESS means everything's OK."); - * print("WARN Tread with caution!"); - * print("WARNING, warning, danger, danger!"); - * print("WARNing! Here be dragons."); - * print("INFO for your I's only (FYI)."); - * print("INFOrmation overload!"); - * // Custom color coding. - * var cyan = "\u001b[36m"; - * var green = "\u001b[32m"; - * var red = "\u001b[31m"; - * var reset = "\u001b[0m"; - * print(red + "Ugh! What a mess." + reset); - * print(green + "Well done!" + reset); - * print(cyan + "ERROR Should this be in red?" + reset); - * tail(); - * ``` - * @example - * ```ts - * // NS2 - * // Default color coding. - * ns.print("ERROR means something's wrong."); - * ns.print("SUCCESS means everything's OK."); - * ns.print("WARN Tread with caution!"); - * ns.print("WARNING, warning, danger, danger!"); - * ns.print("WARNing! Here be dragons."); - * ns.print("INFO for your I's only (FYI)."); - * ns.print("INFOrmation overload!"); - * // Custom color coding. - * const cyan = "\u001b[36m"; - * const green = "\u001b[32m"; - * const red = "\u001b[31m"; - * const reset = "\u001b[0m"; - * ns.print(`${red}Ugh! What a mess.${reset}`); - * ns.print(`${green}Well done!${reset}`); - * ns.print(`${cyan}ERROR Should this be in red?${reset}`); - * ns.tail(); - * ``` - * - * @param args - Value(s) to be printed. - */ - print(...args: any[]): void; - - /** - * Prints a formatted string to the script’s logs. - * @remarks - * RAM cost: 0 GB - * - * - See {@link NS.print | print} for how to add color to your printed strings. - * - * - For more detail, see: https://github.com/alexei/sprintf.js - * - * @example - * ```ts - * // NS1 - * var name = "Bit"; - * var age = 4; - * printf("My name is %s.", name); - * printf("I'm %d seconds old.", age); - * printf("My age in binary is %b.", age); - * printf("My age in scientific notation is %e.", age); - * printf("In %d seconds, I'll be %s.", 6, "Byte"); - * printf("Am I a nibble? %t", (4 == age)); - * tail(); - * ``` - * @example - * ```ts - * // NS2 - * const name = "Bit"; - * const age = 4; - * ns.printf("My name is %s.", name); - * ns.printf("I'm %d seconds old.", age); - * ns.printf("My age in binary is %b.", age); - * ns.printf("My age in scientific notation is %e.", age); - * ns.printf("In %d seconds, I'll be %s.", 6, "Byte"); - * ns.printf("Am I a nibble? %t", (4 == age)); - * ns.tail(); - * ``` - * - * @param format - Format of the message. - * @param args - Value(s) to be printed. - */ - printf(format: string, ...args: any[]): void; - - /** - * Prints one or more values or variables to the Terminal. - * @remarks - * RAM cost: 0 GB - * - * See {@link NS.print | print} for how to add color to your printed strings. - * - * @param args - Value(s) to be printed. - */ - tprint(...args: any[]): void; - - /** - * Prints a raw value or a variable to the Terminal. - * @remarks - * RAM cost: 0 GB - * - * - See {@link NS.print | print} for how to add color to your printed strings. - * - * - See {@link NS.printf | printf} for examples on formatted strings. - * - * - For more detail, see: https://github.com/alexei/sprintf.js - * - * @param format - Format of the message. - * @param values - Value(s) to be printed. - */ - tprintf(format: string, ...values: any[]): void; - - /** - * Clears the script’s logs. - * @remarks - * RAM cost: 0 GB - */ - clearLog(): void; - - /** - * Disables logging for the given function. - * @remarks - * RAM cost: 0 GB - * - * Logging can be disabled for all functions by passing `ALL` as the argument. - * - * @param fn - Name of function for which to disable logging. - */ - disableLog(fn: string): void; - - /** - * Enable logging for a certain function. - * @remarks - * RAM cost: 0 GB - * - * 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`). - * - * @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 - * RAM cost: 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; - - /** - * Get all the logs of a script. - * @remarks - * RAM cost: 0 GB - * - * 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 - * ```ts - * // NS1: - * //Get logs from foo.script on the current server that was run with no args - * getScriptLogs("foo.script"); - * - * //Open logs from foo.script on the foodnstuff server that was run with no args - * getScriptLogs("foo.script", "foodnstuff"); - * - * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] - * getScriptLogs("foo.script", "foodnstuff", 1, "test"); - * ``` - * @example - * ```ts - * // NS2: - * //Get logs from foo.script on the current server that was run with no args - * ns.getScriptLogs("foo.script"); - * - * //Open logs from foo.script on the foodnstuff server that was run with no args - * ns.getScriptLogs("foo.script", "foodnstuff"); - * - * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] - * ns.getScriptLogs("foo.script", "foodnstuff", 1, "test"); - * ``` - * @param fn - Optional. Filename of script to get logs from. - * @param host - Optional. Hostname of the server that the script is on. - * @param args - Arguments to identify which scripts to get logs for. - * @returns Returns a string array, where each line is an element in the array. The most recently logged line is at the end of the array. - */ - getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[]; - - /** - * Get an array of recently killed scripts across all servers. - * @remarks - * RAM cost: 0.2 GB - * - * The most recently killed script is the first element in the array. - * Note that there is a maximum number of recently killed scripts which are tracked. - * This is configurable in the game's options as `Recently killed scripts size`. - * - * @example - * ```ts - * let recentScripts = ns.getRecentScripts(); - * let mostRecent = recentScripts.shift() - * if (mostRecent) - * ns.tprint(mostRecent.logs.join('\n')) - * ``` - * - * @returns Array with information about previously killed scripts. - */ - getRecentScripts(): RecentScript[]; - - /** - * Open the tail window of a script. - * @remarks - * RAM cost: 0 GB - * - * 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 - * ```ts - * // NS1: - * //Open logs from foo.script on the current server that was run with no args - * tail("foo.script"); - * - * //Get logs from foo.script on the foodnstuff server that was run with no args - * tail("foo.script", "foodnstuff"); - * - * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] - * tail("foo.script", "foodnstuff", 1, "test"); - * ``` - * @example - * ```ts - * // NS2: - * //Open logs from foo.script on the current server that was run with no args - * ns.tail("foo.script"); - * - * //Get logs from foo.script on the foodnstuff server that was run with no args - * ns.tail("foo.script", "foodnstuff"); - * - * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] - * ns.tail("foo.script", "foodnstuff", 1, "test"); - * ``` - * @param fn - Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. - * @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. - * @param args - Arguments for the script being tailed. - */ - tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void; - - /** - * Move a tail window. - * @remarks - * RAM cost: 0 GB - * - * Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0). - * - * @param x - x coordinate. - * @param y - y coordinate. - * @param pid - Optional. PID of the script having its tail moved. If omitted, the current script is used. - */ - moveTail(x: number, y: number, pid?: number): void; - - /** - * Resize a tail window. - * @remarks - * RAM cost: 0 GB - * - * Resize a tail window. Size are in pixel. - * - * @param width - Width of the window. - * @param height - Height of the window. - * @param pid - Optional. PID of the script having its tail resized. If omitted, the current script is used. - */ - resizeTail(width: number, height: number, pid?: number): void; - - /** - * Close the tail window of a script. - * @remarks - * RAM cost: 0 GB - * - * Closes a script’s logs. This is functionally the same as pressing the "Close" button on the tail window. - * - * If the function is called with no arguments, it will close the current script’s logs. - * - * Otherwise, the pid argument can be used to close the logs from another script. - * - * @param pid - Optional. PID of the script having its tail closed. If omitted, the current script is used. - */ - closeTail(pid?: number): void; - - /** - * Get the list of servers connected to a server. - * @remarks - * RAM cost: 0.2 GB - * - * Returns an array containing the hostnames of all servers that are one - * node way from the specified target server. The hostnames in the returned - * array are strings. - * - * @example - * ```ts - * // NS1 - * // All servers that are one hop from the current server. - * tprint("Neighbors of current server."); - * var neighbor = scan(); - * for (var i = 0; i < neighbor.length; i++) { - * tprint(neighbor[i]); - * } - * // All neighbors of n00dles. - * var target = "n00dles"; - * neighbor = scan(target); - * tprintf("Neighbors of %s.", target); - * for (var i = 0; i < neighbor.length; i++) { - * tprint(neighbor[i]); - * } - * ``` - * @example - * ```ts - * // NS2 - * // All servers that are one hop from the current server. - * ns.tprint("Neighbors of current server."); - * let neighbor = ns.scan(); - * for (let i = 0; i < neighbor.length; i++) { - * ns.tprint(neighbor[i]); - * } - * // All neighbors of n00dles. - * const target = "n00dles"; - * neighbor = ns.scan(target); - * ns.tprintf("Neighbors of %s.", target); - * for (let i = 0; i < neighbor.length; i++) { - * ns.tprint(neighbor[i]); - * } - * ``` - * - * @param host - Optional. Hostname of the server to scan, default to current server. - * @returns Returns an array of hostnames. - */ - scan(host?: string): string[]; - - /** Returns whether the player has access to the darkweb. - * @remarks - * RAM cost: 0.05GB - * - * @example - * ```js - * // NS1: - * if (hasTorRouter()) tprint("TOR router detected."); - * ``` - * - * @example - * ```js - * // NS2: - * if (ns.hasTorRouter()) tprint("TOR router detected."); - * ``` - * - * @returns Whether player has access to the dark web. */ - hasTorRouter(): boolean; - - /** - * Runs NUKE.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Running NUKE.exe on a target server gives you root access which means you can execute scripts on said server. NUKE.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * nuke("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.nuke("foodnstuff"); - * ``` - * @param host - Hostname of the target server. - */ - nuke(host: string): void; - - /** - * Runs BruteSSH.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * brutessh("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.brutessh("foodnstuff"); - * ``` - * @param host - Hostname of the target server. - */ - brutessh(host: string): void; - - /** - * Runs FTPCrack.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * ftpcrack("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.ftpcrack("foodnstuff"); - * ``` - * @param host - Hostname of the target server. - */ - ftpcrack(host: string): void; - - /** - * Runs relaySMTP.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * relaysmtp("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.relaysmtp("foodnstuff"); - * ``` - * @param host - Hostname of the target server. - */ - relaysmtp(host: string): void; - - /** - * Runs HTTPWorm.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * httpworm("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.httpworm("foodnstuff"); - * ``` - * @param host - Hostname of the target server. - */ - httpworm(host: string): void; - - /** - * Runs SQLInject.exe on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer. - * - * @example - * ```ts - * // NS1: - * sqlinject("foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * ns.sqlinject("foodnstuff"); - * ``` - * @remarks RAM cost: 0.05 GB - * @param host - Hostname of the target server. - */ - sqlinject(host: string): void; - - /** - * Start another script on the current server. - * @remarks - * RAM cost: 1 GB - * - * 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 or less will cause a runtime error. - * - * @example - * ```ts - * // NS1: - * //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"); - * - * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: - * run("foo.script", 5); - * - * //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'); - * ``` - * @example - * ```ts - * // NS2: - * //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: - * ns.run("foo.script"); - * - * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: - * ns.run("foo.script", 5); - * - * //This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: - * ns.run("foo.script", 1, 'foodnstuff'); - * ``` - * @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: string, numThreads?: number, ...args: (string | number | boolean)[]): number; - - /** - * Start another script on any server. - * @remarks - * RAM cost: 1.3 GB - * - * Run a script as a separate process on a specified server. This is similar to the function {@link NS.run | run} - * except that it can be used to run a script on any server, instead of just the current server. - * - * If the script was successfully started, then this function returns the PID of that script. - * Otherwise, it returns 0. - * - * PID stands for Process ID. The PID is a unique identifier for each script. - * The PID will always be a positive integer. - * - * Running this function with a numThreads argument of 0 or less will cause a runtime error. - * - * @example - * ```ts - * // NS1: - * // The simplest way to use the exec command is to call it with just the script name - * // and the target server. The following example will try to run generic-hack.script - * // on the foodnstuff server. - * exec("generic-hack.script", "foodnstuff"); - * - * // The following example will try to run the script generic-hack.script on the - * // joesguns server with 10 threads. - * exec("generic-hack.script", "joesguns", 10); - * - * // This last example will try to run the script foo.script on the foodnstuff server - * // with 5 threads. It will also pass the number 1 and the string “test” in as - * // arguments to the script. - * exec("foo.script", "foodnstuff", 5, 1, "test"); - * ``` - * @example - * ```ts - * // NS2: - * // The simplest way to use the exec command is to call it with just the script name - * // and the target server. The following example will try to run generic-hack.script - * // on the foodnstuff server. - * ns.exec("generic-hack.script", "foodnstuff"); - * - * // The following example will try to run the script generic-hack.script on the - * // joesguns server with 10 threads. - * ns.exec("generic-hack.script", "joesguns", 10); - * - * // This last example will try to run the script foo.script on the foodnstuff server - * // with 5 threads. It will also pass the number 1 and the string “test” in as - * // arguments to the script. - * ns.exec("foo.script", "foodnstuff", 5, 1, "test"); - * ``` - * @param script - Filename of script to execute. - * @param host - Hostname of the `target server` on which to execute the script. - * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. - * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. - * @returns Returns the PID of a successfully started script, and 0 otherwise. - */ - exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number; - - /** - * Terminate current script and start another in 10 seconds. - * @remarks - * RAM cost: 2 GB - * - * 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. - * - * Running this function with a numThreads argument of 0 or less will cause a runtime error. - * - * @example - * ```ts - * // NS1: - * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: - * spawn('foo.script', 10, 'foodnstuff', 90); - * ``` - * @example - * ```ts - * // NS2: - * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: - * ns.spawn('foo.script', 10, 'foodnstuff', 90); - * ``` - * @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: string, numThreads?: number, ...args: (string | number | boolean)[]): void; - - /** - * Terminate another script. - * @remarks - * RAM cost: 0.5 GB - * - * Kills the script on the target server specified by the script’s name and arguments. - * Remember that scripts are uniquely identified by both their names 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 name. - * - * @example - * ```ts - * // NS1: - * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: - * kill("foo.script", "foodnstuff"); - * - * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: - * kill("foo.script", getHostname()); - * - * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: - * kill("foo.script", getHostname(), 1, "foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: - * ns.kill("foo.script", "foodnstuff"); - * - * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: - * ns.kill("foo.script", getHostname()); - * - * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: - * ns.kill("foo.script", getHostname(), 1, "foodnstuff"); - * ``` - * @param script - Filename or PID of the script to kill. - * @param host - Hostname 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: number): boolean; - - /** - * {@inheritDoc NS.(kill:1)} - * @example - * ```ts - * // NS1: - * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: - * kill("foo.script", "foodnstuff"); - * - * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: - * kill("foo.script", getHostname()); - * - * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: - * kill("foo.script", getHostname(), 1, "foodnstuff"); - * ``` - * @example - * ```ts - * // NS2: - * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: - * ns.kill("foo.script", "foodnstuff"); - * - * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: - * ns.kill("foo.script", getHostname()); - * - * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: - * ns.kill("foo.script", getHostname(), 1, "foodnstuff"); - * ``` - */ - kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean; - - /** - * Terminate all scripts on a server. - * @remarks - * RAM cost: 0.5 GB - * - * 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. - * If no host is defined, it will kill all scripts, where the script is running. - * - * @param host - IP or hostname of the server on which to kill all scripts. - * @param safetyguard - Skips the script that calls this function - * @returns True if any scripts were killed, and false otherwise. - */ - killall(host?: string, safetyguard?: boolean): boolean; - - /** - * Terminates the current script immediately. - * @remarks - * RAM cost: 0 GB - */ - exit(): never; - - /** - * Copy file between servers. - * @remarks - * RAM cost: 0.6 GB - * - * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string - * specifying a single file to copy, or an array of strings specifying multiple files to copy. - * - * @example - * ```ts - * // NS1: - * //Copies foo.lit from the helios server to the home computer: - * scp("foo.lit", "home", "helios"); - * - * //Tries to copy three files from rothman-uni to home computer: - * files = ["foo1.lit", "foo2.script", "foo3.script"]; - * scp(files, "home", "rothman-uni"); - * ``` - * @example - * ```ts - * // NS2: - * //Copies foo.lit from the helios server to the home computer: - * ns.scp("foo.lit", "home", "helios" ); - * - * //Tries to copy three files from rothman-uni to home computer: - * files = ["foo1.lit", "foo2.script", "foo3.script"]; - * ns.scp(files, "home", "rothman-uni"); - * ``` - * @example - * ```ts - * //ns2, copies files from home to a target server - * const server = ns.args[0]; - * const files = ["hack.js","weaken.js","grow.js"]; - * ns.scp(files, server, "home"); - * ``` - * @param files - Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading `/`. - * @param destination - Hostname of the destination server, which is the server to which the file will be copied. - * @param source - Hostname 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. - * @returns True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed. - */ - scp(files: string | string[], destination: string, source?: string): boolean; - - /** - * List files on a server. - * @remarks - * RAM cost: 0.2 GB - * - * Returns an array with the filenames of all files on the specified server - * (as strings). The returned array is sorted in alphabetic order. - * - * @param host - Hostname 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: string, grep?: string): string[]; - - /** - * List running scripts on a server. - * @remarks - * RAM cost: 0.2 GB - * - * Returns an array with general information about all scripts running on the specified target server. - * - * @example - * ```ts - * // NS1: - * var scripts = ps("home"); - * for (var i = 0; i < scripts.length; ++i) { - * tprint(scripts[i].filename + ' ' + scripts[i].threads); - * tprint(scripts[i].args); - * } - * ``` - * @example - * ```ts - * // NS2: - * const ps = ns.ps("home"); - * for (let script of ps) { - * ns.tprint(`${script.filename} ${script.threads}`); - * ns.tprint(script.args); - * } - * ``` - * @param host - Host 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?: string): ProcessInfo[]; - - /** - * Check if you have root access on a server. - * @remarks - * RAM cost: 0.05 GB - * - * Returns a boolean indicating whether or not the player has root access to the specified target server. - * - * @example - * ```ts - * // NS1: - * if (hasRootAccess("foodnstuff") == false) { - * nuke("foodnstuff"); - * } - * ``` - * @example - * ```ts - * // NS2: - * if (ns.hasRootAccess("foodnstuff") == false) { - * ns.nuke("foodnstuff"); - * } - * ``` - * @param host - Hostname of the target server. - * @returns True if player has root access to the specified target server, and false otherwise. - */ - hasRootAccess(host: string): boolean; - - /** - * Returns a string with the hostname of the server that the script is running on. - * - * @remarks - * RAM cost: 0.05 GB - * @returns Hostname of the server that the script runs on. - */ - getHostname(): string; - - /** - * Returns the player’s current hacking level. - * - * @remarks - * RAM cost: 0.05 GB - * @returns Player’s current hacking level - */ - getHackingLevel(): number; - - /** - * Get hacking related multipliers. - * @remarks - * RAM cost: 0.25 GB - * - * 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 - * ```ts - * // NS1: - * // Example of how this can be used: - * var mults = getHackingMultipliers(); - * print(mults.chance); - * print(mults.growth); - * ``` - * @example - * ```ts - * // NS2: - * // Example of how this can be used: - * const {chance, growth} = ns.getHackingMultipliers(); - * print(chance); - * print(growth); - * ``` - * @returns Object containing the Player’s hacking related multipliers. - */ - getHackingMultipliers(): HackingMultipliers; - - /** - * Get hacknet related multipliers. - * @remarks - * RAM cost: 0.25 GB - * - * 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 - * ```ts - * // NS1: - * // Example of how this can be used: - * var mults = getHacknetMultipliers(); - * print(mults.production); - * print(mults.purchaseCost); - * ``` - * @example - * ```ts - * // NS2: - * // Example of how this can be used: - * const {production, purchaseCost} = ns.getHacknetMultipliers(); - * print(production); - * print(purchaseCost); - * ``` - * @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 - * RAM cost: 2 GB - * @param host - Optional. Hostname for the requested server object. - * @returns The requested server object. - */ - getServer(host?: string): Server; - - /** - * Get money available on a server. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the amount of money available on a server. - * Running this function on the home computer will return the player’s money. - * - * @example - * ```ts - * // NS1: - * getServerMoneyAvailable("foodnstuff"); - * getServerMoneyAvailable("home"); //Returns player's money - * ``` - * @example - * ```ts - * // NS2: - * ns.getServerMoneyAvailable("foodnstuff"); - * ns.getServerMoneyAvailable("home"); // Returns player's money - * ``` - * @param host - Hostname of target server. - * @returns Amount of money available on the server. - */ - getServerMoneyAvailable(host: string): number; - - /** - * Get the maximum money available on a server. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the maximum amount of money that can be available on a server. - * - * @param host - Hostname of target server. - * @returns Maximum amount of money available on the server. - */ - getServerMaxMoney(host: string): number; - - /** - * Get a server growth parameter. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the server’s intrinsic “growth parameter”. This growth - * parameter is a number typically between 0 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. - * - * @param host - Hostname of target server. - * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function. - */ - getServerGrowth(host: string): number; - - /** - * Get server security level. - * @remarks - * RAM cost: 0.1 GB - * - * 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). - * - * @param host - Hostname of target server. - * @returns Security level of the target server. - */ - getServerSecurityLevel(host: string): number; - - /** - * Returns the minimum security level of the target server. - * - * @remarks RAM cost: 0.1 GB - * @param host - Hostname of target server. - * @returns Minimum security level of the target server. - */ - getServerMinSecurityLevel(host: string): number; - - /** - * @deprecated useless - * @remarks - * RAM cost: 0.1 GB - * 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). - * - * @param host - Host of target server. - * @returns Base security level of the target server. - */ - getServerBaseSecurityLevel(host: string): number; - - /** - * Get the maximum amount of RAM on a server. - * @remarks - * RAM cost: 0.05 GB - * - * @param host - Hostname of the target server. - * @returns The maximum amount of RAM (GB) a server can have. - */ - getServerMaxRam(host: string): number; - /** - * Get the used RAM on a server. - * @remarks - * RAM cost: 0.05 GB - * - * @param host - Hostname of the target server. - * @returns The amount of used RAM (GB) on the specified server. - */ - getServerUsedRam(host: string): number; - - /** - * Returns the required hacking level of the target server. - * - * @remarks RAM cost: 0.1 GB - * @param host - Hostname of target server. - * @returns The required hacking level of the target server. - */ - getServerRequiredHackingLevel(host: string): number; - - /** - * Returns the number of open ports required to successfully run NUKE.exe on the specified server. - * - * @remarks RAM cost: 0.1 GB - * @param host - Hostname of target server. - * @returns The number of open ports required to successfully run NUKE.exe on the specified server. - */ - getServerNumPortsRequired(host: string): number; - - /** - * Returns a boolean denoting whether or not the specified server exists. - * - * @remarks RAM cost: 0.1 GB - * @param host - Hostname of target server. - * @returns True if the specified server exists, and false otherwise. - */ - serverExists(host: string): boolean; - - /** - * Check if a file exists. - * @remarks - * RAM cost: 0.1 GB - * - * 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 - * ```ts - * // NS1: - * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. - * fileExists("foo.script", "foodnstuff"); - * - * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. - * fileExists("ftpcrack.exe"); - * ``` - * * @example - * ```ts - * // NS2: - * // The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. - * ns.fileExists("foo.script", "foodnstuff"); - * - * // The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. - * ns.fileExists("ftpcrack.exe"); - * ``` - * @param filename - Filename of file to check. - * @param host - Host 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?: string): boolean; - - /** - * Check if a script is running. - * @remarks - * RAM cost: 0.1 GB - * - * Returns a boolean indicating whether the specified script is running on the target server. - * If you use a PID instead of a filename, the hostname and args parameters are unnecessary. - * Remember that a script is uniquely identified by both its name and its arguments. - * - * @example - * ```ts - * // NS1: - * //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"); - * - * //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()); - * - * //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"); - * ``` - * @example - * ```ts - * // NS2: - * //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: - * ns.isRunning("foo.script", "foodnstuff"); - * - * //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: - * ns.isRunning("foo.script", ns.getHostname()); - * - * //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: - * ns.isRunning("foo.script", "joesguns", 1, 5, "test"); - * ``` - * @param script - Filename or PID of script to check. This is case-sensitive. - * @param host - Hostname of target server. - * @param args - Arguments to specify/identify which scripts to search for. - * @returns True if the specified script is running on the target server, and false otherwise. - */ - isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean; - - /** - * Get general info about a running script. - * @remarks - * RAM cost: 0.3 GB - * - * Running with no args returns current script. - * If you use a PID as the first parameter, the hostname and args parameters are unnecessary. - * - * @param filename - Optional. Filename or PID of the script. - * @param hostname - Optional. Name of host server the script is running on. - * @param args - Arguments to identify the script - * @returns The info about the running script if found, and null otherwise. - */ - getRunningScript( - filename?: FilenameOrPID, - hostname?: string, - ...args: (string | number | boolean)[] - ): RunningScript | null; - - /** - * Get cost of purchasing a server. - * @remarks - * RAM cost: 0.25 GB - * - * Returns the cost to purchase a server with the specified amount of ram. - * - * @example - * ```ts - * // NS1: - * for (i = 1; i <= 20; i++) { - * tprint(i + " -- " + getPurchasedServerCost(Math.pow(2, i))); - * } - * ``` - * @example - * ```ts - * // NS2: - * for (i = 1; i <= 20; i++) { - * ns.tprint(i + " -- " + ns.getPurchasedServerCost(Math.pow(2, i))); - * } - * ``` - * @param ram - Amount of RAM of a potential purchased server, in GB. 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; - - /** - * Purchase a server. - * @remarks - * 2.25 GB - * - * Purchase 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, then 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 - * ```ts - * // NS1: - * var ram = 64; - * var prefix = "pserv-"; - * for (i = 0; i < 5; ++i) { - * purchaseServer(prefix + i, ram); - * } - * ``` - * @example - * ```ts - * // NS2: - * const ram = 64; - * const prefix = "pserv-"; - * for (i = 0; i < 5; ++i) { - * ns.purchaseServer(prefix + i, ram); - * } - * ``` - * @param hostname - Hostname of the purchased server. - * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). - * @returns The hostname of the newly purchased server. - */ - purchaseServer(hostname: string, ram: number): string; - - /** - * Get cost of upgrading a purchased server to the given ram. - * @remarks - * RAM cost: 0.1 GB - * - * @param hostname - Hostname of the server to upgrade. - * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). - * @returns The price to upgrade. - */ - getPurchasedServerUpgradeCost(hostname: string, ram: number): number; - - /** - * Upgrade a purchased server's RAM. - * @remarks - * RAM cost: 0.25 GB - * - * @param hostname - Hostname of the server to upgrade. - * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). - * @returns True if the upgrade succeeded, and false otherwise. - */ - upgradePurchasedServer(hostname: string, ram: number): boolean; - - /** - * Rename a purchased server. - * @remarks - * RAM cost: 2.00 GB - * - * @param hostname - Current server hostname. - * @param newName - New server hostname. - * @returns True if the upgrade succeeded, and false otherwise. - */ - renamePurchasedServer(hostname: string, newName: string): boolean; - - /** - * Delete a purchased server. - * @remarks - * 2.25 GB - * - * 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. - * - * @param host - Hostname of the server to delete. - * @returns True if successful, and false otherwise. - */ - deleteServer(host: string): boolean; - - /** - * Returns an array with the hostnames of all of the servers you have purchased. - * - * @remarks 2.25 GB - * @returns Returns an array with the hostnames of all of the servers you have purchased. - */ - getPurchasedServers(): string[]; - - /** - * Returns the maximum number of servers you can purchase. - * - * @remarks RAM cost: 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 RAM cost: 0.05 GB - * @returns Returns the maximum RAM (in GB) that a purchased server can have. - */ - getPurchasedServerMaxRam(): number; - - /** - * Write data to a file. - * @remarks - * RAM cost: 0 GB - * - * This function can be used to write data to a text file (.txt) or a script (.js or .script). - * - * This function will write data to that file. If the specified file does not exist, - * then it will be created. The third argument mode defines how the data will be written to - * the 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 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 file. - * - * @param filename - Name of the file to be written to. - * @param data - Data to write. - * @param mode - Defines the write mode. - */ - write(filename: string, data?: string, mode?: "w" | "a"): void; - - /** - * Attempt to write to a port. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @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. - */ - tryWritePort(port: number, data: string | number): boolean; - - /** - * Read content of a file. - * @remarks - * RAM cost: 0 GB - * - * This function is used to read data from a text file (.txt) or script (.script, .js). - * - * This function will return the data in the specified file. - * If the file does not exist, an empty string will be returned. - * - * @param filename - Name of the file to be read. - * @returns Data in the specified text file. - */ - read(filename: string): string; - - /** - * Get a copy of the data from a port without popping it. - * @remarks - * RAM cost: 0 GB - * - * 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. - * - * @param port - Port to peek. Must be an integer between 1 and 20. - * @returns Data in the specified port. - */ - peek(port: number): PortData; - - /** - * Clear data from a file. - * @remarks - * RAM cost: 0 GB - * - * Delete all data from that text file. - * - * @param handle - Text file to clear. - */ - clear(handle: string): void; - - /** - * Clear data from a port. - * @remarks - * RAM cost: 0 GB - * - * Delete all data from the underlying queue. - * - * @param handle - Port to clear. - */ - clearPort(handle: number): void; - - /** - * Write data to a port. - * @remarks - * RAM cost: 0 GB - * - * Write data to the given Netscript port. - * @returns The data popped off the queue if it was full, or null if it was not full. - */ - writePort(port: number, data: string | number): PortData | null; - /** - * Read data from a port. - * @remarks - * RAM cost: 0 GB - * - * 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. - * @returns The data read. - */ - readPort(port: number): PortData; - - /** - * Get all data on a port. - * @remarks - * RAM cost: 0 GB - * - * 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 - * @param port - Port number. Must be an integer between 1 and 20. - */ - getPortHandle(port: number): NetscriptPort; - - /** - * Delete a file. - * @remarks - * RAM cost: 1 GB - * - * Removes the specified file from the current server. This function works for every file - * type except message (.msg) files. - * - * @param name - Filename of file to remove. Must include the extension. - * @param host - Hostname 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?: string): boolean; - - /** - * Check if any script with a filename is running. - * @remarks - * RAM cost: 1 GB - * - * 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 NS.isRunning | isRunning} function because it does not try to - * identify a specific instance of a running script by its arguments. - * - * @example - * ```ts - * // NS1: - * //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"); - * - * //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()); - * ``` - * * @example - * ```ts - * // NS2: - * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: - * ns.scriptRunning("foo.script", "foodnstuff"); - * - * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: - * ns.scriptRunning("foo.script", ns.getHostname()); - * ``` - * @param script - Filename of script to check. This is case-sensitive. - * @param host - Hostname of target server. - * @returns True if the specified script is running, and false otherwise. - */ - scriptRunning(script: string, host: string): boolean; - - /** - * Kill all scripts with a filename. - * @remarks - * RAM cost: 1 GB - * - * Kills all scripts with the specified filename on the target server specified by hostname, - * regardless of arguments. - * - * @param script - Filename of script to kill. This is case-sensitive. - * @param host - Hostname of target server. - * @returns True if one or more scripts were successfully killed, and false if none were. - */ - scriptKill(script: string, host: string): boolean; - - /** - * Returns the current script name. - * - * @remarks RAM cost: 0 GB - * @returns Current script name. - */ - getScriptName(): string; - - /** - * Get the ram cost of a script. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the amount of RAM required to run the specified script on the target server. - * Returns 0 if the script does not exist. - * - * @param script - Filename of script. This is case-sensitive. - * @param host - Hostname of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server. - * @returns Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist. - */ - getScriptRam(script: string, host?: string): number; - - /** - * Get the execution time of a hack() call. - * @remarks - * RAM cost: 0.05 GB - * - * When `hack` completes an amount of money is stolen depending on the player's skills. - * Returns the amount of time in milliseconds it takes to execute the {@link NS.hack | hack} Netscript function on the target server. - * The required time is increased by the security level of the target server and decreased by the player's hacking level. - * - * @param host - Hostname of target server. - * @returns Returns the amount of time in milliseconds it takes to execute the {@link NS.hack | hack} Netscript function. - */ - getHackTime(host: string): number; - - /** - * Get the execution time of a grow() call. - * @remarks - * RAM cost: 0.05 GB - * - * Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. - * The required time is increased by the security level of the target server and decreased by the player's hacking level. - * - * @param host - Hostname of target server. - * @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function. - */ - getGrowTime(host: string): number; - - /** - * Get the execution time of a weaken() call. - * @remarks - * RAM cost: 0.05 GB - * - * Returns the amount of time in milliseconds it takes to execute the {@link NS.weaken | weaken} Netscript function on the target server. - * The required time is increased by the security level of the target server and decreased by the player's hacking level. - * - * @param host - Hostname of target server. - * @returns Returns the amount of time in milliseconds it takes to execute the {@link NS.weaken | weaken} Netscript function. - */ - getWeakenTime(host: string): number; - - /** - * Get the income of all scripts. - * @remarks - * RAM cost: 0.1 GB - * - * @returns An array of two values. - * The first value is the total income (dollar / second) of all of your active scripts - * (scripts that are currently running on any server). - * The second value is the total income (dollar / second) that you’ve earned from scripts - * since you last installed Augmentations. - */ - getTotalScriptIncome(): [number, number]; - - /** - * Get the income of a script. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the amount of income the specified script generates while online - * (when the game is open, does not apply for offline income). Remember that - * a script is uniquely identified by both its name and its arguments. So for - * example if you ran a script with the arguments “foodnstuff” and “5” then - * in order to use this function to get that script’s income you must specify - * those same arguments in the same order in this function call. - * - * @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: string, host: string, ...args: (string | number | boolean)[]): number; - - /** - * Get the exp gain of all scripts. - * @remarks - * RAM cost: 0.1 GB - * - * @returns Total experience gain rate of all of your active scripts. - */ - getTotalScriptExpGain(): number; - - /** - * Get the exp gain of a script. - * @remarks - * RAM cost: 0.1 GB - * - * Returns the amount of hacking experience the specified script generates while online - * (when the game is open, does not apply for offline experience gains). Remember that a - * script is uniquely identified by both its name and its arguments. - * - * This function can also return the total experience gain rate of all of your active - * scripts by running the function with no arguments. - * - * @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: string, host: string, ...args: (string | number | boolean)[]): number; - - /** - * Returns the amount of time in milliseconds that have passed since you last installed Augmentations. - * - * @remarks RAM cost: 0.05 GB - * @returns Time in milliseconds that have passed since you last installed Augmentations. - */ - getTimeSinceLastAug(): number; - - /** - * Format a string. - * - * @remarks - * RAM cost: 0 GB - * - * see: https://github.com/alexei/sprintf.js - * @param format - String to format. - * @param args - Formatting arguments. - * @returns Formatted text. - */ - sprintf(format: string, ...args: any[]): string; - - /** - * Format a string with an array of arguments. - * @remarks - * RAM cost: 0 GB - * - * see: https://github.com/alexei/sprintf.js - * @param format - String to format. - * @param args - Formatting arguments. - * @returns Formatted text. - */ - vsprintf(format: string, args: any[]): string; - - /** - * Format a number. - * @remarks - * RAM cost: 0 GB - * - * Converts a number into a string with the specified formatter. - * This uses the numeral.js library, so the formatters must be compatible with that. - * This is the same function that the game itself uses to display numbers. - * - * For more information, see: http://numeraljs.com/ - * - * @param n - Number to format. - * @param format - Formatter. - * @returns Formatted number. - */ - nFormat(n: number, format: string): string; - - /** - * Format time to a readable string. - * @remarks - * RAM cost: 0 GB - * - * @param milliseconds - Number of millisecond to format. - * @param milliPrecision - Format time with subsecond precision. Defaults to false. - * @returns The formatted time. - */ - tFormat(milliseconds: number, milliPrecision?: boolean): string; - - /** - * Prompt the player with an input modal. - * @remarks - * RAM cost: 0 GB - * - * Prompts the player with a dialog box. Here is an explanation of the various options. - * - * - `options.type` is not provided to the function. If `options.type` is left out and - * only a string is passed to the function, then the default behavior is to create a - * boolean dialog box. - * - * - `options.type` has value `undefined` or `"boolean"`. A boolean dialog box is - * created. The player is shown "Yes" and "No" prompts, which return true and false - * respectively. The script's execution is halted until the player presses either the - * "Yes" or "No" button. - * - * - `options.type` has value `"text"`. The player is given a text field to enter - * free-form text. The script's execution is halted until the player enters some text - * and/or presses the "Confirm" button. - * - * - `options.type` has value `"select"`. The player is shown a drop-down field. - * Choosing type `"select"` will require an array to be passed via the - * `options.choices` property. The array can be an array of strings, an array of - * numbers (not BigInt numbers), or a mixture of both numbers and strings. Any other - * types of array elements will result in an error or an undefined/unexpected - * behavior. The `options.choices` property will be ignored if `options.type` has a - * value other than `"select"`. The script's execution is halted until the player - * chooses one of the provided options and presses the "Confirm" button. - * - * @example - * ```ts - * // NS1 - * // A Yes/No question. The default is to create a boolean dialog box. - * var queryA = "Do you enjoy Bitburner?"; - * var resultA = prompt(queryA); - * tprint(queryA + " " + resultA); - * - * // Another Yes/No question. Can also create a boolean dialog box by explicitly - * // passing the option {"type": "boolean"}. - * var queryB = "Is programming fun?"; - * var resultB = prompt(queryB, { type: "boolean" }); - * tprint(queryB + " " + resultB); - * - * // Free-form text box. - * var resultC = prompt("Please enter your name.", { type: "text" }); - * tprint("Hello, " + resultC + "."); - * - * // A drop-down list. - * var resultD = prompt("Please select your favorite fruit.", { - * type: "select", - * choices: ["Apple", "Banana", "Orange", "Pear", "Strawberry"] - * }); - * tprint("Your favorite fruit is " + resultD.toLowerCase() + "."); - * ``` - * @example - * ```ts - * // NS2 - * // A Yes/No question. The default is to create a boolean dialog box. - * const queryA = "Do you enjoy Bitburner?"; - * const resultA = await ns.prompt(queryA); - * ns.tprint(`${queryA} ${resultA}`); - * - * // Another Yes/No question. Can also create a boolean dialog box by explicitly - * // passing the option {"type": "boolean"}. - * const queryB = "Is programming fun?"; - * const resultB = await ns.prompt(queryB, { type: "boolean" }); - * ns.tprint(`${queryB} ${resultB}`); - * - * // Free-form text box. - * const resultC = await ns.prompt("Please enter your name.", { type: "text" }); - * ns.tprint(`Hello, ${resultC}.`); - * - * // A drop-down list. - * const resultD = await ns.prompt("Please select your favorite fruit.", { - * type: "select", - * choices: ["Apple", "Banana", "Orange", "Pear", "Strawberry"] - * }); - * ns.tprint(`Your favorite fruit is ${resultD.toLowerCase()}.`); - * ``` - * - * @param txt - Text to appear in the prompt dialog box. - * @param options - Options to modify the prompt the player is shown. - * @returns True if the player clicks “Yes”; false if the player clicks “No”; or the value entered by the player. - */ - prompt( - txt: string, - options?: { type?: "boolean" | "text" | "select"; choices?: string[] }, - ): Promise; - - /** - * Open up a message box. - * @param msg - Message to alert. - */ - alert(msg: string): void; - - /** - * Queue a toast (bottom-right notification). - * @param msg - Message in the toast. - * @param variant - Type of toast. Must be one of success, info, warning, error. Defaults to success. - * @param duration - Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000. - */ - toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void; - - /** - * Download a file from the internet. - * @remarks - * RAM cost: 0 GB - * - * 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, .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 {@link NS.hack | hack} or {@link NS.sleep | sleep}). - * wget will still work in Netscript 1.0, but the function's 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 - * ```ts - * // NS1: - * wget("https://raw.githubusercontent.com/bitburner-official/bitburner-src/master/README.md", "game_readme.txt"); - * ``` - * @example - * ```ts - * // NS2: - * await ns.wget("https://raw.githubusercontent.com/bitburner-official/bitburner-src/master/README.md", "game_readme.txt"); - * ``` - * @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 RAM cost: 0.1 GB - * @returns Amount of Faction favor required to be able to donate to a faction. - */ - getFavorToDonate(): number; - - /** - * Get the current Bitnode multipliers. - * @remarks - * RAM cost: 4 GB - * - * Returns an object containing the current (or supplied) BitNode multipliers. - * This function requires you to be in Bitnode 5 or have 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 - * ```ts - * // NS1: - * var mults = getBitNodeMultipliers(); - * print(mults.ServerMaxMoney); - * print(mults.HackExpGain); - * ``` - * @example - * ```ts - * // NS2: - * const {ServerMaxMoney, HackExpGain} = ns.getBitNodeMultipliers(); - * print(ServerMaxMoney); - * print(HackExpGain); - * ``` - * @returns Object containing the current BitNode multipliers. - */ - getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers; - - /** - * Get information about the player. - * @remarks - * RAM cost: 0.5 GB - * - * Returns an object with information on the current player. - * - * @returns Player info - */ - getPlayer(): Player; - - /** - * Get information about the sources of income for this run. - * @remarks - * RAM cost: 1.0 GB - * - * Returns an object with information on the income sources for this run - * - * @returns Money sources - */ - getMoneySources(): MoneySources; - - /** - * Add callback function when the script dies - * @remarks - * RAM cost: 0 GB - * - * NS2 exclusive - * - * Add callback to be executed when the script dies. - */ - atExit(f: () => void): void; - - /** - * Move a file on the target server. - * @remarks - * RAM cost: 0 GB - * - * NS2 exclusive. - * - * Move the source file to the specified destination on the target server. - * - * This command only works for scripts and text files (.txt). It cannot, however, be used - * to convert from script to text file, or vice versa. - * - * This function can also be used to rename files. - * - * @param host - Hostname of target server. - * @param source - Filename of the source file. - * @param destination - Filename of the destination file. - */ - mv(host: string, source: string, destination: string): void; - - /** - * Parse command line flags. - * @remarks - * RAM cost: 0 GB - * - * Allows Unix-like flag parsing. - * @example - * ```ts - * // example.script - * var data = flags([ - * ['delay', 0], // a default number means this flag is a number - * ['server', 'foodnstuff'], // a default string means this flag is a string - * ['exclude', []], // a default array means this flag is a default array of string - * ['help', false], // a default boolean means this flag is a boolean - * ]); - * tprint(data); - * - * // example.js - * export async function main(ns) { - * const data = ns.flags([ - * ['delay', 0], // a default number means this flag is a number - * ['server', 'foodnstuff'], // a default string means this flag is a string - * ['exclude', []], // a default array means this flag is a default array of string - * ['help', false], // a default boolean means this flag is a boolean - * ]); - * ns.tprint(data); - * } - * - * // [home ~/]> run example.script - * // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false} - * // [home ~/]> run example.script --delay 3000 - * // {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000} - * // [home ~/]> run example.script --delay 3000 --server harakiri-sushi - * // {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} - * // [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world - * // {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} - * // [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b - * // {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]} - * // [home ~/]> run example.script --help - * // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true} - * ``` - */ - flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; - - /** - * Share your computer with your factions. - * @remarks - * RAM cost: 2.4 GB - * - * Increases your rep gain of hacking contracts while share is called. - * Scales with thread count. - */ - share(): Promise; - - /** - * Calculate your share power. Based on all the active share calls. - * @remarks - * RAM cost: 0.2 GB - */ - getSharePower(): number; - - enums: NSEnums; -} - -/** @public */ -export declare type NSEnums = { - CityName: typeof CityName; - CrimeType: typeof CrimeType; - FactionWorkType: typeof FactionWorkType; - GymType: typeof GymType; - JobName: typeof JobName; - LocationName: typeof LocationName; - ToastVariant: typeof ToastVariant; - UniversityClassType: typeof UniversityClassType; -}; - -/** - * Office for a division in a city. - * @public - */ -export declare interface Office { - /** City of the office */ - loc: CityName; - /** Maximum number of employee */ - size: number; - /** Maximum amount of energy of the employees */ - maxEne: number; - /** Maximum happiness of the employees */ - maxHap: number; - /** Maximum morale of the employees */ - maxMor: number; - /** Amount of employees */ - employees: number; - /** Average energy of the employees */ - avgEne: number; - /** Average happiness of the employees */ - avgHap: number; - /** Average morale of the employees */ - avgMor: number; - /** Production of the employees */ - employeeProd: Record; - /** Positions of the employees */ - employeeJobs: Record; -} - -/** - * Corporation Office API - * @remarks - * requires the Office API upgrade from your corporation. - * @public - */ - -export declare interface OfficeAPI { - /** - * Hire an employee. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param employeePosition - Position to place into. Defaults to "Unassigned". - * @returns True if an employee was hired, false otherwise - */ - hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean; - /** - * Upgrade office size. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param size - Amount of positions to open - */ - upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void; - /** - * Throw a party for your employees - * @param divisionName - Name of the division - * @param city - Name of the city - * @param costPerEmployee - Amount to spend per employee. - * @returns Multiplier for happiness and morale, or zero on failure - */ - throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number; - /** - * Buy coffee for your employees - * @param divisionName - Name of the division - * @param city - Name of the city - * @returns true if buying coffee was successful, false otherwise - */ - buyCoffee(divisionName: string, city: CityName | `${CityName}`): boolean; - /** - * Hire AdVert. - * @param divisionName - Name of the division - */ - hireAdVert(divisionName: string): void; - /** - * Purchase a research - * @param divisionName - Name of the division - * @param researchName - Name of the research - */ - research(divisionName: string, researchName: string): void; - /** - * Get data about an office - * @param divisionName - Name of the division - * @param city - Name of the city - * @returns Office data - */ - getOffice(divisionName: string, city: CityName | `${CityName}`): Office; - /** - * Get the cost to hire AdVert. - * @param divisionName - Name of the division. - * @returns The cost to hire AdVert. - */ - getHireAdVertCost(divisionName: string): number; - /** - * Get the number of times you have hired AdVert. - * @param divisionName - Name of the division. - * @returns Number of times you have hired AdVert. - */ - getHireAdVertCount(divisionName: string): number; - /** - * Get the cost to unlock research - * @param divisionName - Name of the division - * @param researchName - Name of the research - * @returns cost - */ - getResearchCost(divisionName: string, researchName: string): number; - /** - * Gets if you have unlocked a research - * @param divisionName - Name of the division - * @param researchName - Name of the research - * @returns true is unlocked, false if not - */ - hasResearched(divisionName: string, researchName: string): boolean; - /** - * Set the auto job assignment for a job - * @param divisionName - Name of the division - * @param city - Name of the city - * @param job - Name of the job - * @param amount - Number of employees to assign to that job - * @returns true if the employee count reached the target amount, false if not - */ - setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean; - /** - * Cost to Upgrade office size. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param size - Amount of positions to open - * @returns Cost of upgrading the office - */ - getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, asize: number): number; -} - -/** @public */ -export declare enum OrderTypes { - LimitBuy = "Limit Buy Order", - LimitSell = "Limit Sell Order", - StopBuy = "Stop Buy Order", - StopSell = "Stop Sell Order", -} - -/** @public */ -export declare interface Person { - hp: HP; - skills: Skills; - exp: Skills; - mults: Multipliers; - city: CityName; -} - -/** @public */ -export declare interface Player extends Person { - money: number; - numPeopleKilled: number; - entropy: number; - jobs: Record; - factions: string[]; - bitNodeN: number; - totalPlaytime: number; - playtimeSinceLastAug: number; - playtimeSinceLastBitnode: number; - location: string; -} - -/** @public */ -export declare type PortData = string | number; - -/** @public */ -export declare enum PositionTypes { - Long = "L", - Short = "S", -} - -/** - * A single process on a server. - * @public - */ -export declare interface ProcessInfo { - /** Script name. */ - filename: string; - /** Number of threads script is running with */ - threads: number; - /** Script's arguments */ - args: (string | number | boolean)[]; - /** Process ID */ - pid: number; -} - -/** - * Product in a warehouse - * @public - */ -export declare interface Product { - /** Name of the product */ - name: string; - /** Demand for the product, only present if "Market Research - Demand" unlocked */ - dmd: number | undefined; - /** Competition for the product, only present if "Market Research - Competition" unlocked */ - cmp: number | undefined; - /** Product Rating */ - rat: number; - /** Product Properties. The data is \{qlt, per, dur, rel, aes, fea\} */ - properties: { [key: string]: number }; - /** Production cost */ - pCost: number; - /** Sell cost, can be "MP+5" */ - sCost: string | number; - /** Data refers to the production, sale, and quantity of the products - * These values are specific to a city - * For each city, the data is [qty, prod, sell] */ - cityData: Record; - /** Creation progress - A number between 0-100 representing percentage */ - developmentProgress: number; -} - -/** @public */ -export declare interface RecentScript extends RunningScript { - /** Timestamp of when the script was killed */ - timeOfDeath: Date; -} - -/** - * Reputation formulas - * @public - */ -export declare interface ReputationFormulas { - /** - * Calculate the total required amount of faction reputation to reach a target favor. - * @param favor - target faction favor. - * @returns The calculated faction reputation required. - */ - calculateFavorToRep(favor: number): number; - /** - * Calculate the resulting faction favor of a total amount of reputation. - * (Faction favor is gained whenever you install an Augmentation.) - * @param rep - amount of reputation. - * @returns The calculated faction favor. - */ - calculateRepToFavor(rep: number): number; - - /** - * Calculate how much rep would be gained. - * @param amount - Amount of money donated - * @param player - Player info from {@link NS.getPlayer | getPlayer} - */ - repFromDonation(amount: number, player: Person): number; -} - -/** @public */ -export declare interface RunningScript { - /** Arguments the script was called with */ - args: (string | number | boolean)[]; - /** Filename of the script */ - filename: string; - /** - * Script logs as an array. The newest log entries are at the bottom. - * Timestamps, if enabled, are placed inside `[brackets]` at the start of each line. - **/ - logs: string[]; - /** Total amount of hacking experience earned from this script when offline */ - offlineExpGained: number; - /** Total amount of money made by this script when offline */ - offlineMoneyMade: number; - /** Number of seconds that the script has been running offline */ - offlineRunningTime: number; - /** Total amount of hacking experience earned from this script when online */ - onlineExpGained: number; - /** Total amount of money made by this script when online */ - onlineMoneyMade: number; - /** Number of seconds that this script has been running online */ - onlineRunningTime: number; - /** Process ID. Must be an integer */ - pid: number; - /** How much RAM this script uses for ONE thread */ - ramUsage: number; - /** Hostname of the server on which this script runs */ - server: string; - /** Number of threads that this script runs with */ - threads: number; -} - -/** @public */ -export declare type ScriptArg = string | number | boolean; - -/** - * A single server. - * @public - */ -export declare interface Server { - /** - * How many CPU cores this server has. Maximum of 8. - * Affects magnitude of grow and weaken. - */ - 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 currently 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; - - /** Flag indicating whether this is a purchased server */ - purchasedByPlayer: boolean; - - /** Flag indicating whether this server has a backdoor installed by a player */ - backdoorInstalled: boolean; - - /** - * Initial server security level - * (i.e. security level when the server was created) - */ - baseDifficulty: number; - - /** Server Security Level */ - hackDifficulty: number; - - /** Minimum server security level that this server can be weakened to */ - minDifficulty: number; - - /** How much money currently resides on the server and can be hacked */ - moneyAvailable: number; - - /** Maximum amount of money that this server can hold */ - moneyMax: number; - - /** Number of open ports required in order to gain admin/root access */ - numOpenPortsRequired: number; - - /** How many ports are currently opened on the server */ - openPortCount: number; - - /** Hacking level required to hack this server */ - requiredHackingSkill: number; - - /** - * Parameter that affects how effectively this server's money can - * be increased using the grow() Netscript function - */ - serverGrowth: number; -} - -/** - * Singularity API - * @remarks - * This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on - * Source-File 4 levels. - * @public - */ -export declare interface Singularity { - /** - * Backup game save. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * This function will automatically opens the backup save prompt and claim the free faction favour if available. - * - */ - exportGame(): void; - - /** - * Returns Backup save bonus availability. - * @remarks - * RAM cost: 0.5 GB * 16/4/1 - * - * - * This function will check if there is a bonus for backing up your save. - * - */ - exportGameBonus(): boolean; - - /** - * Take university class. - * - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * 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. - * - * @param universityName - Name of university. You must be in the correct city for whatever university you specify. - * @param courseName - Name of course. - * @param focus - Acquire player focus on this class. Optional. Defaults to true. - * @returns True if action is successfully started, false otherwise. - */ - universityCourse(universityName: string, courseName: string, focus?: boolean): boolean; - - /** - * Workout at the gym. - * - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - - * 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 - * - * @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. - * @param focus - Acquire player focus on this gym workout. Optional. Defaults to true. - * @returns True if actions is successfully started, false otherwise. - */ - gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; - - /** - * Travel to another city. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * 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. - * - * @param city - City to travel to. - * @returns True if action is successful, false otherwise. - */ - travelToCity(city: CityName | `${CityName}`): boolean; - - /** - * Purchase the TOR router. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * 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. - * - * @returns True if actions is successful or you already own TOR router, false otherwise. - */ - purchaseTor(): boolean; - - /** - * Purchase a program from the dark web. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * 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 - * ```ts - * // NS1 - * purchaseProgram("brutessh.exe"); - * ``` - * @example - * ```ts - * // NS2 - * ns.purchaseProgram("brutessh.exe"); - * ``` - * @param programName - Name of program to purchase. - * @returns True if the specified program is purchased, and false otherwise. - */ - purchaseProgram(programName: string): boolean; - - /** - * Check if the player is busy. - * @remarks - * RAM cost: 0.5 GB * 16/4/1 - * - * - * Returns a boolean indicating whether or not the player is currently performing an - * ‘action’. These actions include working for a company/faction, studying at a university, - * working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. - * - * @returns True if the player is currently performing an ‘action’, false otherwise. - */ - isBusy(): boolean; - - /** - * Stop the current action. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * 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 out at a gym - * * Working for a company/faction - * * Creating a program - * * Committing a crime - * - * This function will return true if the player’s action was ended. - * It will return false if the player was not performing an action when this function was called. - * - * @returns True if the player’s action was ended, false if the player was not performing an action. - */ - stopAction(): boolean; - - /** - * Upgrade home computer RAM. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * 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. - * - * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise. - */ - upgradeHomeRam(): boolean; - - /** - * Upgrade home computer cores. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * This function will upgrade amount of cores 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 cores is successfully upgraded, and false otherwise. - * - * @returns True if the player’s home computer cores is successfully upgraded, and false otherwise. - */ - upgradeHomeCores(): boolean; - - /** - * Get the price of upgrading home RAM. - * @remarks - * RAM cost: 1.5 GB * 16/4/1 - * - * - * Returns the cost of upgrading the player’s home computer RAM. - * - * @returns Cost of upgrading the player’s home computer RAM. - */ - getUpgradeHomeRamCost(): number; - - /** - * Get the price of upgrading home cores. - * @remarks - * RAM cost: 1.5 GB * 16/4/1 - * - * - * Returns the cost of upgrading the player’s home computer cores. - * - * @returns Cost of upgrading the player’s home computer cores. - */ - getUpgradeHomeCoresCost(): number; - - /** - * Work for a company. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * This function will set you to start working at your current job at a specified 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 cancel that action. - * - * This function will return true if the player starts working, and false otherwise. - * - * @example - * ```js - * // NS1: - * var COMPANY_NAME = "Noodle Bar"; - * - * var success = singularity.workForCompany(COMPANY_NAME); - * if (!success) tprint("ERROR: Failed to start work at " + COMPANY_NAME + "."); - * ``` - * @example - * ```js - * // NS2: - * const COMPANY_NAME = "Noodle Bar"; - * - * let success = ns.singularity.workForCompany(COMPANY_NAME); - * if (!success) ns.tprint(`ERROR: Failed to start work at ${COMPANY_NAME].`); - * ``` - * @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. - * @param focus - Acquire player focus on this work operation. Optional. Defaults to true. - * @returns True if the player starts working, and false otherwise. - */ - workForCompany(companyName: string, focus?: boolean): boolean; - - /** - * Quit jobs by company. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * This function will finish work with the company provided and quit any jobs. - * - * @param companyName - Name of the company. - */ - quitJob(companyName?: string): void; - - /** - * Apply for a job at a company. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * 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. - * - * @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: string, field: string): boolean; - - /** - * Get company reputation. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * 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. - * - * @param companyName - Name of the company. - * @returns Amount of reputation you have at the specified company. - */ - getCompanyRep(companyName: string): number; - - /** - * Get company favor. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * 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. - * - * @param companyName - Name of the company. - * @returns Amount of favor you have at the specified company. - */ - getCompanyFavor(companyName: string): number; - - /** - * Get company favor gain. - * @remarks - * RAM cost: 0.75 GB * 16/4/1 - * - * - * This function will return the amount of favor you will gain for the specified - * company when you reset by installing Augmentations. - * - * @param companyName - Name of the company. - * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. - */ - getCompanyFavorGain(companyName: string): number; - - /** - * List all current faction invitations. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * Returns an array with the name of all Factions you currently have outstanding invitations from. - * - * @returns Array with the name of all Factions you currently have outstanding invitations from. - */ - checkFactionInvitations(): string[]; - - /** - * Join a faction. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * This function will automatically accept an invitation from a faction and join it. - * - * @param faction - Name of faction to join. - * @returns True if player joined the faction, and false otherwise. - */ - joinFaction(faction: string): boolean; - - /** - * Work for a faction. - * @remarks - * RAM cost: 3 GB * 16/4/1 - * - * - * This function will set you to start working for the specified faction. You must be a member of the faction and - * that faction must have the specified work type, 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 cancel that action. - * - * This function will return true if you successfully start working for the specified faction, and false otherwise. - * - * @example - * ```js - * // NS1 - * var FACTION_NAME = "CyberSec", WORK_TYPE = "hacking"; - * - * var success = singularity.workForFaction(FACTION_NAME, WORK_TYPE); - * if (!success) tprint("ERROR: Failed to start work for " + FACTION_NAME + " with work type " + WORK_TYPE); - * ``` - * @example - * ```js - * // NS2 - * const FACTION_NAME = "CyberSec", WORK_TYPE = "hacking"; - * - * let success = ns.singularity.workForFaction(FACTION_NAME, WORK_TYPE); - * if (!success) ns.tprint(`ERROR: Failed to start work for ${FACTION_NAME} with work type ${WORK_TYPE}.`) - * ``` - * @param faction - Name of faction to work for. - * @param workType - Type of work to perform for the faction. - * @param focus - Acquire player focus on this work operation. Optional. Defaults to true. - * @returns True if the player starts working, and false otherwise. - */ - workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean; - - /** - * Get faction reputation. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * This function returns the amount of reputation you have for the specified faction. - * - * @param faction - Name of faction to work for. - * @returns Amount of reputation you have for the specified faction. - */ - getFactionRep(faction: string): number; - - /** - * Get faction favor. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * This function returns the amount of favor you have for the specified faction. - * - * @param faction - Name of faction. - * @returns Amount of favor you have for the specified faction. - */ - getFactionFavor(faction: string): number; - - /** - * Get faction favor gain. - * @remarks - * RAM cost: 0.75 GB * 16/4/1 - * - * - * This function returns the amount of favor you will gain for the specified - * faction when you reset by installing Augmentations. - * - * @param faction - Name of faction. - * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations. - */ - getFactionFavorGain(faction: string): number; - - /** - * Donate to a faction. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * Attempts to donate money to the specified faction in exchange for reputation. - * Returns true if you successfully donate the money, and false otherwise. - * - * @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: string, amount: number): boolean; - - /** - * Create a program. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * 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 - * ```ts - * // NS1: - * createProgram(“relaysmtp.exe”); - * ``` - * @example - * ```ts - * // NS2: - * ns.createProgram(“relaysmtp.exe”); - * ``` - * @param program - Name of program to create. - * @param focus - Acquire player focus on this program creation. Optional. Defaults to true. - * @returns True if you successfully start working on the specified program, and false otherwise. - */ - createProgram(program: string, focus?: boolean): boolean; - - /** - * Commit a crime. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * 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 milliseconds 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,000). - * - * @param crime - Name of crime to attempt. - * @param focus - Acquire player focus on this crime. Optional. Defaults to true. - * @returns The number of milliseconds it takes to attempt the specified crime. - */ - commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number; - - /** - * Get chance to successfully commit a crime. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * This function returns your chance of success at committing the specified crime. - * - * @param crime - Name of crime. - * @returns Chance of success at committing the specified crime. - */ - getCrimeChance(crime: CrimeType | `${CrimeType}`): number; - - /** - * Get stats related to a crime. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * Returns the stats of the crime. - * - * @param crime - Name of crime. - * @returns The stats of the crime. - */ - getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats; - - /** - * Get a list of owned augmentation. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * This function returns an array containing the names (as strings) of all Augmentations you have. - * - * @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): string[]; - - /** - * Get a list of acquired Source-Files. - * @remarks - * RAM cost: 5 GB - * - * - * Returns an array of source files - * - * @returns Array containing an object with number and level of the source file. - */ - getOwnedSourceFiles(): SourceFileLvl[]; - - /** - * Get a list of augmentation available from a faction. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * Returns an array containing the names (as strings) of all Augmentations - * that are available from the specified faction. - * - * @param faction - Name of faction. - * @returns Array containing the names of all Augmentations. - */ - getAugmentationsFromFaction(faction: string): string[]; - - /** - * Get the pre-requisite of an augmentation. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * 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. - * - * @param augName - Name of Augmentation. - * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. - */ - getAugmentationPrereq(augName: string): string[]; - - /** - * Get price of an augmentation. - * @remarks - * RAM cost: 2.5 GB * 16/4/1 - * - * - * @param augName - Name of Augmentation. - * @returns Price of the augmentation. - */ - getAugmentationPrice(augName: string): number; - - /** - * Get base price of an augmentation. - * @remarks - * RAM cost: 2.5 GB * 16/4/1 - * - * - * @param augName - Name of Augmentation. - * @returns Base price of the augmentation, before price multiplier. - */ - getAugmentationBasePrice(augName: string): number; - - /** - * Get reputation requirement of an augmentation. - * @remarks - * RAM cost: 2.5 GB * 16/4/1 - * - * - * @param augName - Name of Augmentation. - * @returns Reputation requirement of the augmentation. - */ - getAugmentationRepReq(augName: string): number; - - /** - * Purchase an augmentation - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * 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. - * - * @param faction - Name of faction to purchase Augmentation from. - * @param augmentation - Name of Augmentation to purchase. - * @returns True if the Augmentation is successfully purchased, and false otherwise. - */ - purchaseAugmentation(faction: string, augmentation: string): boolean; - - /** - * Get the stats of an augmentation. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * This function returns augmentation stats. - * - * @param name - Name of Augmentation. CASE-SENSITIVE. - * @returns Augmentation stats. - */ - getAugmentationStats(name: string): Multipliers; - - /** - * Install your purchased augmentations. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * This function will automatically install your Augmentations, resetting the game as usual. If you do not own uninstalled Augmentations then the game will not reset. - * - * @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. - */ - installAugmentations(cbScript?: string): void; - - /** - * Hospitalize the player. - * @remarks - * RAM cost: 0.25 GB * 16/4/1 - */ - hospitalize(): void; - - /** - * Soft reset the game. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * This function will perform a reset even if you don’t have any augmentation installed. - * - * @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. - */ - softReset(cbScript: string): void; - - /** - * Go to a location. - * @remarks - * RAM cost: 5 GB * 16/4/1 - * - * - * Move the player to a specific location. - * - * @param locationName - Name of the location. - * @returns True if the player was moved there, false otherwise. - */ - goToLocation(locationName: string): boolean; - - /** - * Get the current server. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * @returns Name of the current server. - */ - getCurrentServer(): string; - - /** - * Connect to a server. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * Run the connect HOSTNAME command in the terminal. Can only connect to neighbors. - * - * @returns True if the connect command was successful, false otherwise. - */ - connect(hostname: string): boolean; - - /** - * Run the hack command in the terminal. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * @returns Amount of money stolen by manual hacking. - */ - manualHack(): Promise; - - /** - * Run the backdoor command in the terminal. - * @remarks - * RAM cost: 2 GB * 16/4/1 - * - * - * @returns Promise waiting for the installation to finish. - */ - installBackdoor(): Promise; - - /** - * Check if the player is focused. - * @remarks - * RAM cost: 0.1 GB * 16/4/1 - * - * - * @returns True if the player is focused. - */ - isFocused(): boolean; - - /** - * Set the players focus. - * @remarks - * RAM cost: 0.1 GB * 16/4/1 - * - * @returns True if the focus was changed. - */ - setFocus(focus: boolean): boolean; - - /** - * Get a list of programs offered on the dark web. - * @remarks - * RAM cost: 1 GB * 16/4/1 - * - * - * This function allows the player to get a list of programs available for purchase - * on the dark web. Players MUST have purchased Tor to get the list of programs - * available. If Tor has not been purchased yet, this function will return an - * empty list. - * - * @example - * ```ts - * // NS1 - * getDarkwebPrograms(); - * // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] - * ``` - * @example - * ```ts - * // NS2 - * ns.getDarkwebPrograms(); - * // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] - * ``` - * @returns - a list of programs available for purchase on the dark web, or [] if Tor has not - * been purchased - */ - getDarkwebPrograms(): string[]; - - /** - * Check the price of an exploit on the dark web - * @remarks - * RAM cost: 0.5 GB * 16/4/1 - * - * - * This function allows you to check the price of a darkweb exploit/program. - * You MUST have a TOR router in order to use this function. The price returned - * by this function is the same price you would see with buy -l from the terminal. - * Returns the cost of the program if it has not been purchased yet, 0 if it - * has already been purchased, or -1 if Tor has not been purchased (and thus - * the program/exploit is not available for purchase). - * - * If the program does not exist, an error is thrown. - * - * - * @example - * ```ts - * // NS1 - * getDarkwebProgramCost("brutessh.exe"); - * ``` - * @example - * ```ts - * // NS2 - * ns.getDarkwebProgramCost("brutessh.exe"); - * ``` - * @param programName - Name of program to check the price of - * @returns Price of the specified darkweb program - * (if not yet purchased), 0 if it has already been purchased, or -1 if Tor has not been - * purchased. Throws an error if the specified program/exploit does not exist - */ - getDarkwebProgramCost(programName: string): number; - - /** - * b1t_flum3 into a different BN. - * @remarks - * RAM cost: 16 GB * 16/4/1 - * - * @param nextBN - BN number to jump to - * @param callbackScript - Name of the script to launch in the next BN. - */ - b1tflum3(nextBN: number, callbackScript?: string): void; - - /** - * Destroy the w0r1d_d43m0n and move on to the next BN. - * @remarks - * RAM cost: 32 GB * 16/4/1 - * - * You must have the special augment installed and the required hacking level - * OR - * Completed the final black op. - * - * @param nextBN - BN number to jump to - * @param callbackScript - Name of the script to launch in the next BN. - */ - destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void; - - /** - * Get the current work the player is doing. - * @remarks - * RAM cost: 0.5 GB * 16/4/1 - * - * @returns - An object representing the current work. Fields depend on the kind of work. - */ - getCurrentWork(): any | null; -} - -/** @public */ -export declare interface Skills { - hacking: number; - strength: number; - defense: number; - dexterity: number; - agility: number; - charisma: number; - intelligence: number; -} - -/** - * Skills formulas - * @public - */ -export declare interface SkillsFormulas { - /** - * Calculate skill level. - * @param exp - experience for that skill - * @param skillMult - Multiplier for that skill, defaults to 1. - * @returns The calculated skill level. - */ - calculateSkill(exp: number, skillMult?: number): number; - /** - * Calculate exp for skill level. - * @param skill - target skill level - * @param skillMult - Multiplier for that skill, defaults to 1. - * @returns The calculated exp required. - */ - calculateExp(skill: number, skillMult?: number): number; -} - -/** - * Sleeve API - * @remarks - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. - * @public - */ -export declare interface Sleeve { - /** - * Get the number of sleeves you own. - * @remarks - * RAM cost: 4 GB - * - * Return the number of duplicate sleeves the player has. - * - * @returns number of duplicate sleeves the player has. - */ - getNumSleeves(): number; - - /** - * Get information about a sleeve. - * @remarks - * RAM cost: 4 GB - * - * Return a person object for this sleeve - * - * storedCycles is the amount of Bonus Time in cycles, each translates to 200ms - * - * @param sleeveNumber - Index of the sleeve to retrieve information. - * @returns Object containing information about this sleeve. - */ - getSleeve(sleeveNumber: number): SleevePerson; - - /** - * Get task of a sleeve. - * @remarks - * RAM cost: 4 GB - * - * Return the current task that the sleeve is performing, or null if the sleeve is idle. All tasks have a "type" - * property, and other available properties depend on the type of task. - * - * @param sleeveNumber - Index of the sleeve to retrieve task from. - * @returns Object containing information for the current task that the sleeve is performing. - */ - getTask(sleeveNumber: number): SleeveTask | null; - - /** - * Set a sleeve to shock recovery. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not this action was set successfully. - * - * @param sleeveNumber - Index of the sleeve to start recovery. - * @returns True if this action was set successfully, false otherwise. - */ - setToShockRecovery(sleeveNumber: number): boolean; - - /** - * Set a sleeve to synchronize. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not this action was set successfully. - * - * @param sleeveNumber - Index of the sleeve to start synchronizing. - * @returns True if this action was set successfully, false otherwise. - */ - setToSynchronize(sleeveNumber: number): boolean; - - /** - * Set a sleeve to commit crime. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not this action was set successfully (false if an invalid action is specified). - * - * @example - * ```ts - * // Assigns the first sleeve to Homicide. - * ns.sleeve.setToCommitCrime(0, "Homicide"); - * - * // Assigns the second sleeve to Grand Theft Auto, using enum - * const crimes = ns.enums.CrimeType; - * ns.sleeve.setToCommitCrime(1, crimes.grandTheftAuto) - * ``` - * - * @param sleeveNumber - Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. - * @param name - Name of the crime. - * @returns True if this action was set successfully, false otherwise. - */ - setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean; - - /** - * Set a sleeve to work for a faction. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not the sleeve started working or this faction. - * - * @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, can also throw on errors - */ - setToFactionWork( - sleeveNumber: number, - factionName: string, - factionWorkType: FactionWorkType | `${FactionWorkType}`, - ): boolean | undefined; - - /** - * Set a sleeve to work for a company. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not the sleeve started working or this company. - * - * @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: string): boolean; - - /** - * Set a sleeve to take a class at a university. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not this action was set successfully. - * - * @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: string, className: string): boolean; - - /** - * Set a sleeve to workout at the gym. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not the sleeve started working out. - * - * @param sleeveNumber - Index of the sleeve to workout at the gym. - * @param 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: string, stat: string): boolean; - - /** - * Make a sleeve travel to another city. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not the sleeve reached destination. - * - * @param sleeveNumber - Index of the sleeve to travel. - * @param city - Name of the destination city. - * @returns True if the sleeve reached destination, false otherwise. - */ - travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; - - /** - * Get augmentations installed on a sleeve. - * @remarks - * RAM cost: 4 GB - * - * Return a list of augmentation names that this sleeve has installed. - * - * @param sleeveNumber - Index of the sleeve to retrieve augmentations from. - * @returns List of augmentation names that this sleeve has installed. - */ - getSleeveAugmentations(sleeveNumber: number): string[]; - - /** - * Get price of an augmentation. - * @remarks - * RAM cost: 4 GB - * - * - * @param augName - Name of Augmentation. - * @returns Price of the augmentation. - */ - getSleeveAugmentationPrice(augName: string): number; - - /** - * Get reputation requirement of an augmentation. - * @remarks - * RAM cost: 4 GB - * - * - * @param augName - Name of Augmentation. - * @returns Reputation requirement of the augmentation. - */ - getSleeveAugmentationRepReq(augName: string): number; - - /** - * List purchasable augs for a sleeve. - * @remarks - * RAM cost: 4 GB - * - * Return a list of augmentations that the player can buy for this sleeve. - * - * @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[]; - - /** - * Purchase an aug for a sleeve. - * @remarks - * RAM cost: 4 GB - * - * Return true if the aug was purchased and installed on the sleeve. - * - * @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: string): boolean; - - /** - * Set a sleeve to perform bladeburner actions. - * @remarks - * RAM cost: 4 GB - * - * Return a boolean indicating whether or not the sleeve started working out. - * - * @param sleeveNumber - Index of the sleeve to workout at the gym. - * @param action - Name of the action to be performed. - * @param contract - Name of the contract if applicable. - * @returns True if the sleeve started working out, false otherwise. - */ - setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean; -} - -/** @public */ -export declare type SleeveBladeburnerTask = { - type: "BLADEBURNER"; - actionType: "General" | "Contracts"; - actionName: string; -}; - -/** @public */ -export declare type SleeveClassTask = { - type: "CLASS"; - classType: UniversityClassType | GymType | `${UniversityClassType}` | `${GymType}`; - location: LocationName | `${LocationName}`; -}; - -/** @public */ -export declare type SleeveCompanyTask = { type: "COMPANY"; companyName: string }; - -/** @public */ -export declare type SleeveCrimeTask = { type: "CRIME"; crimeType: CrimeType | `${CrimeType}` }; - -/** @public */ -export declare type SleeveFactionTask = { - type: "FACTION"; - factionWorkType: FactionWorkType | `${FactionWorkType}`; - factionName: string; -}; - -/** @public */ -export declare type SleeveInfiltrateTask = { type: "INFILTRATE" }; - -/** @public */ -export declare interface SleevePerson extends Person { - /** Number 0-100 Experience earned and shared is multiplied with shock% before sync% */ - shock: number; - /** Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% */ - sync: number; - /** Number 1-100 initial Value of sync on BN start */ - memory: number; - /** Number of 200ms cycles which are stored as bonus time */ - storedCycles: number; -} - -/** @public */ -export declare type SleeveRecoveryTask = { type: "RECOVERY" }; - -/** @public */ -export declare type SleeveSupportTask = { type: "SUPPORT" }; - -/** @public */ -export declare type SleeveSynchroTask = { type: "SYNCHRO" }; - -/** Object representing a sleeve current task. - * @public */ -export declare type SleeveTask = -| SleeveBladeburnerTask -| SleeveClassTask -| SleeveCompanyTask -| SleeveCrimeTask -| SleeveFactionTask -| SleeveInfiltrateTask -| SleeveRecoveryTask -| SleeveSupportTask -| SleeveSynchroTask; - -/** @public */ -export declare interface SourceFileLvl { - /** The number of the source file */ - n: number; - /** The level of the source file */ - lvl: number; -} - -/** - * Stanek's Gift API. - * @public - */ -export declare interface Stanek { - /** - * Stanek's Gift width. - * @remarks - * RAM cost: 0.4 GB - * @returns The width of the gift. - */ - giftWidth(): number; - /** - * Stanek's Gift height. - * @remarks - * RAM cost: 0.4 GB - * @returns The height of the gift. - */ - giftHeight(): number; - - /** - * Charge a fragment, increasing its power. - * @remarks - * RAM cost: 0.4 GB - * @param rootX - rootX Root X against which to align the top left of the fragment. - * @param rootY - rootY Root Y against which to align the top left of the fragment. - * @returns Promise that lasts until the charge action is over. - */ - chargeFragment(rootX: number, rootY: number): Promise; - - /** - * List possible fragments. - * @remarks - * RAM cost: 0 GB - * - * @returns List of possible fragments. - */ - fragmentDefinitions(): Fragment[]; - - /** - * List of fragments in Stanek's Gift. - * @remarks - * RAM cost: 5 GB - * - * @returns List of active fragments placed on Stanek's Gift. - */ - activeFragments(): ActiveFragment[]; - - /** - * Clear the board of all fragments. - * @remarks - * RAM cost: 0 GB - */ - clearGift(): void; - - /** - * Check if fragment can be placed at specified location. - * @remarks - * RAM cost: 0.5 GB - * - * @param rootX - rootX Root X against which to align the top left of the fragment. - * @param rootY - rootY Root Y against which to align the top left of the fragment. - * @param rotation - rotation A number from 0 to 3, the mount of 90 degree turn to take. - * @param fragmentId - fragmentId ID of the fragment to place. - * @returns true if the fragment can be placed at that position. false otherwise. - */ - canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; - /** - * Place fragment on Stanek's Gift. - * @remarks - * RAM cost: 5 GB - * - * @param rootX - X against which to align the top left of the fragment. - * @param rootY - Y against which to align the top left of the fragment. - * @param rotation - A number from 0 to 3, the mount of 90 degree turn to take. - * @param fragmentId - ID of the fragment to place. - * @returns true if the fragment can be placed at that position. false otherwise. - */ - placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; - /** - * Get placed fragment at location. - * @remarks - * RAM cost: 5 GB - * - * @param rootX - X against which to align the top left of the fragment. - * @param rootY - Y against which to align the top left of the fragment. - * @returns The fragment at [rootX, rootY], if any. - */ - getFragment(rootX: number, rootY: number): ActiveFragment | undefined; - - /** - * Remove fragment at location. - * @remarks - * RAM cost: 0.15 GB - * - * @param rootX - X against which to align the top left of the fragment. - * @param rootY - Y against which to align the top left of the fragment. - * @returns The fragment at [rootX, rootY], if any. - */ - removeFragment(rootX: number, rootY: number): boolean; - - /** - * Accept Stanek's Gift by joining the Church of the Machine God - * @remarks - * RAM cost: 2 GB - * - * @returns true if the player is a member of the church and has the gift installed, - * false otherwise. - */ - acceptGift(): boolean; -} - -/** - * Return value of {@link TIX.getOrders | getOrders} - * - * Keys are stock symbols, properties are arrays of {@link StockOrderObject} - * @public - */ -export declare interface StockOrder { - [key: string]: StockOrderObject[]; -} - -/** - * Value in map of {@link StockOrder} - * @public - */ -export declare interface StockOrderObject { - /** Number of shares */ - shares: number; - /** Price per share */ - price: number; - /** Order type */ - type: OrderTypes; - /** Order position */ - position: PositionTypes; -} - -/** - * Stock market API - * @public - */ -export declare interface TIX { - /** - * Returns true if the player has access to a WSE Account - * @remarks RAM cost: 0.05 GB - */ - hasWSEAccount(): boolean; - /** - * Returns true if the player has access to the TIX API - * @remarks RAM cost: 0.05 GB - */ - hasTIXAPIAccess(): boolean; - /** - * Returns true if the player has access to the 4S Data - * @remarks RAM cost: 0.05 GB - */ - has4SData(): boolean; - /** - * Returns true if the player has access to the 4SData TIX API - * @remarks RAM cost: 0.05 GB - */ - has4SDataTIXAPI(): boolean; - /** - * Returns an array of the symbols of the tradable stocks - * - * @remarks RAM cost: 2 GB - * @returns Array of the symbols of the tradable stocks. - */ - getSymbols(): string[]; - - /** - * Returns the price of a stock. - * - * @remarks - * RAM cost: 2 GB - * - * The stock’s price is the average of its bid and ask prices. This function requires - * that you have the following: - * - * 1. WSE Account - * - * 1. TIX API Access - * - * @example - * ```js - * const fourSigmaStockPrice = ns.stock.getPrice("FSIG"); - * - * // Choose the first stock symbol from the array of stock symbols. Get the price - * // of the corresponding stock. - * const sym = ns.stock.getSymbols()[0]; - * ns.tprint("Stock symbol: " + sym); - * ns.tprint("Stock price: " + ns.stock.getPrice(sym)); - * ``` - * @param sym - Stock symbol. - * @returns The price of a stock. - */ - getPrice(sym: string): number; - - /** - * Returns the organization associated with a stock symbol. - * - * @remarks - * RAM cost: 2 GB - * - * The organization associated with the corresponding stock symbol. This function - * requires that you have the following: - * - * 1. WSE Account - * - * 1. TIX API Access - * - * @example - * ```ts - * // NS1 - * stock.getOrganization("FSIG"); - * - * // Choose the first stock symbol from the array of stock symbols. Get the - * // organization associated with the corresponding stock symbol - * var sym = stock.getSymbols()[0]; - * tprint("Stock symbol: " + sym); - * tprint("Stock organization: " + stock.getOrganization(sym)); - * ``` - * @example - * ```ts - * // NS2 - * ns.stock.getOrganization("FSIG"); - * - * // Choose the first stock symbol from the array of stock symbols. Get the - * // organization associated with the corresponding stock symbol. - * const sym = ns.stock.getSymbols()[0]; - * ns.tprint("Stock symbol: " + sym); - * ns.tprint("Stock organization: " + ns.stock.getOrganization(sym)); - * ``` - * @param sym - Stock symbol. - * @returns The organization assicated with the stock symbol. - */ - getOrganization(sym: string): string; - - /** - * Returns the ask price of that stock. - * @remarks RAM cost: 2 GB - * - * @param sym - Stock symbol. - * @returns The ask price of a stock. - */ - getAskPrice(sym: string): number; - - /** - * Returns the bid price of that stock. - * @remarks RAM cost: 2 GB - * - * @param sym - Stock symbol. - * @returns The bid price of a stock. - */ - getBidPrice(sym: string): number; - - /** - * Returns the player’s position in a stock. - * @remarks - * RAM cost: 2 GB - * 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 - * ```ts - * // NS1 - * var pos = stock.getPosition("ECP"); - * var shares = pos[0]; - * var avgPx = pos[1]; - * var sharesShort = pos[2]; - * var avgPxShort = pos[3]; - * ``` - * @example - * ```ts - * // NS2 - * const [shares, avgPx, sharesShort, avgPxShort] = ns.stock.getPosition("ECP"); - * ``` - * @param sym - Stock symbol. - * @returns Array of four elements that represents the player’s position in a stock. - */ - getPosition(sym: string): [number, number, number, number]; - - /** - * Returns the maximum number of shares of a stock. - * @remarks - * RAM cost: 2 GB - * This is the maximum amount of the stock that can be purchased - * in both the Long and Short positions combined. - * - * @param sym - Stock symbol. - * @returns Maximum number of shares that the stock has. - */ - getMaxShares(sym: string): number; - - /** - * Calculates cost of buying stocks. - * @remarks - * RAM cost: 2 GB - * 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. - * - * @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: string, shares: number, posType: string): number; - - /** - * Calculate profit of selling stocks. - * @remarks - * RAM cost: 2 GB - * 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. - * - * @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: string, shares: number, posType: string): number; - - /** - * Buy stocks. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @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. - */ - buyStock(sym: string, shares: number): number; - - /** - * Sell stocks. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @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. - */ - sellStock(sym: string, shares: number): number; - - /** - * Short stocks. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @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. - */ - buyShort(sym: string, shares: number): number; - - /** - * Sell short stock. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @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: string, shares: number): number; - - /** - * Place order for stocks. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @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: string, shares: number, price: number, type: string, pos: string): boolean; - - /** - * Cancel order for stocks. - * @remarks - * RAM cost: 2.5 GB - * Cancels an outstanding Limit or Stop order on the stock market. - * - * The ability to use limit and stop orders is **not** immediately available to the player and - * must be unlocked later on in the game. - * - * @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: string, shares: number, price: number, type: string, pos: string): void; - - /** - * Returns your order book for the stock market. - * @remarks - * RAM cost: 2.5 GB - * This is an object containing information for all the Limit and Stop Orders you have in the stock market. - * For each symbol you have a position in, the returned object will have a key with that symbol's name. - * The object's properties are each an array of {@link StockOrderObject} - * The object has the following structure: - * - * ```ts - * { - * string1: [ // 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 - * }, - * { - * ... - * }, - * ... - * ], - * string2: [ // 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 - * ```ts - * "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", - * }, - * ], - * } - * ``` - * @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. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @param sym - Stock symbol. - * @returns Volatility of the specified stock. - */ - getVolatility(sym: string): number; - - /** - * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next - * tick. - * @remarks - * RAM cost: 2.5 GB - * 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. - * - * @param sym - Stock symbol. - * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. - */ - getForecast(sym: string): number; - - /** - * Purchase 4S Market Data Access. - * @remarks RAM cost: 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. - * @remarks RAM cost: 2.5 GB - * @returns True if you successfully purchased it or if you already have access, false otherwise. - */ - purchase4SMarketDataTixApi(): boolean; - - /** - * Purchase WSE Account. - * @remarks RAM cost: 2.5 GB - * @returns True if you successfully purchased it or if you already have access, false otherwise. - */ - purchaseWseAccount(): boolean; - - /** - * Purchase TIX API Access - * @remarks RAM cost: 2.5 GB - * @returns True if you successfully purchased it or if you already have access, false otherwise. - */ - purchaseTixApi(): boolean; -} - -/** @public */ -export declare enum ToastVariant { - SUCCESS = "success", - WARNING = "warning", - ERROR = "error", - INFO = "info", -} - -/** @public */ -export declare enum UniversityClassType { - computerScience = "Computer Science", - dataStructures = "Data Structures", - networks = "Networks", - algorithms = "Algorithms", - management = "Management", - leadership = "Leadership", -} - -/** - * User Interface API. - * @public - */ -export declare interface UserInterface { - /** - * Get the current window size - * @remarks - * RAM cost: 0 GB - * - * @returns An array of 2 value containing the window width and height. - */ - windowSize(): [number, number]; - - /** - * Get the current theme - * @remarks - * RAM cost: 0 GB - * - * @returns An object containing the theme's colors - */ - getTheme(): UserInterfaceTheme; - - /** - * Sets the current theme - * @remarks - * RAM cost: 0 GB - * @example - * Usage example (NS2) - * ```ts - * const theme = ns.ui.getTheme(); - * theme.primary = '#ff5500'; - * ns.ui.setTheme(theme); - * ``` - */ - setTheme(newTheme: UserInterfaceTheme): void; - - /** - * Resets the player's theme to the default values - * @remarks - * RAM cost: 0 GB - */ - resetTheme(): void; - - /** - * Get the current styles - * @remarks - * RAM cost: 0 GB - * - * @returns An object containing the player's styles - */ - getStyles(): IStyleSettings; - - /** - * Sets the current styles - * @remarks - * RAM cost: 0 GB - * @example - * Usage example (NS2) - * ```ts - * const styles = ns.ui.getStyles(); - * styles.fontFamily = 'Comic Sans Ms'; - * ns.ui.setStyles(styles); - * ``` - */ - setStyles(newStyles: IStyleSettings): void; - - /** - * Resets the player's styles to the default values - * @remarks - * RAM cost: 0 GB - */ - resetStyles(): void; - - /** - * Gets the current game information (version, commit, ...) - * @remarks - * RAM cost: 0 GB - */ - getGameInfo(): GameInfo; - - /** - * Clear the Terminal window, as if the player ran `clear` in the terminal - * @remarks - * RAM cost: 0.2 GB - */ - clearTerminal(): void; -} - -/** - * Interface Theme - * @public - */ -export declare interface UserInterfaceTheme { - [key: string]: string | undefined; - primarylight: string; - primary: string; - primarydark: string; - successlight: string; - success: string; - successdark: string; - errorlight: string; - error: string; - errordark: string; - secondarylight: string; - secondary: string; - secondarydark: string; - warninglight: string; - warning: string; - warningdark: string; - infolight: string; - info: string; - infodark: string; - welllight: string; - well: string; - white: string; - black: string; - hp: string; - money: string; - hack: string; - combat: string; - cha: string; - int: string; - rep: string; - disabled: string; - backgroundprimary: string; - backgroundsecondary: string; - button: string; -} - -/** - * Warehouse for a division in a city - * @public - */ -export declare interface Warehouse { - /** Amount of size upgrade bought */ - level: number; - /** City in which the warehouse is located */ - loc: CityName; - /** Total space in the warehouse */ - size: number; - /** Used space in the warehouse */ - sizeUsed: number; - /** Smart Supply status in the warehouse */ - smartSupplyEnabled: boolean; -} - -/** - * Corporation Warehouse API - * @remarks - * Requires the Warehouse API upgrade from your corporation. - * @public - */ -export declare interface WarehouseAPI { - /** - * Set material sell data. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param amt - Amount to sell, can be "MAX" - * @param price - Price to sell, can be "MP" - */ - sellMaterial( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - amt: string, - price: string, - ): void; - /** - * Set product sell data. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param productName - Name of the product - * @param amt - Amount to sell, can be "MAX" - * @param price - Price to sell, can be "MP" - * @param all - Sell in all city - */ - sellProduct( - divisionName: string, - city: CityName | `${CityName}`, - productName: string, - amt: string, - price: string, - all: boolean, - ): void; - /** - * Discontinue a product. - * @param divisionName - Name of the division - * @param productName - Name of the product - */ - discontinueProduct(divisionName: string, productName: string): void; - /** - * Set smart supply - * @param divisionName - Name of the division - * @param city - Name of the city - * @param enabled - smart supply enabled - */ - setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: boolean): void; - /** - * Set whether smart supply uses leftovers before buying - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param enabled - smart supply use leftovers enabled - */ - setSmartSupplyUseLeftovers( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - enabled: boolean, - ): void; - /** - * Set material buy data - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param amt - Amount of material to buy - */ - buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; - /** - * Set material to bulk buy - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param amt - Amount of material to buy - */ - bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; - /** - * Get warehouse data - * @param divisionName - Name of the division - * @param city - Name of the city - * @returns warehouse data - */ - getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; - /** - * Get product data - * @param divisionName - Name of the division - * @param productName - Name of the product - * @returns product data - */ - getProduct(divisionName: string, productName: string): Product; - /** - * Get material data - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @returns material data - */ - getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string): Material; - /** - * Set market TA 1 for a material. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param on - market ta enabled - */ - setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; - /** - * Set market TA 2 for a material. - * @param divisionName - Name of the division - * @param city - Name of the city - * @param materialName - Name of the material - * @param on - market ta enabled - */ - setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; - /** - * Set market TA 1 for a product. - * @param divisionName - Name of the division - * @param productName - Name of the product - * @param on - market ta enabled - */ - setProductMarketTA1(divisionName: string, productName: string, on: boolean): void; - /** - * Set market TA 2 for a product. - * @param divisionName - Name of the division - * @param productName - Name of the product - * @param on - market ta enabled - */ - setProductMarketTA2(divisionName: string, productName: string, on: boolean): void; - /** - * Set material export data - * @param sourceDivision - Source division - * @param sourceCity - Source city - * @param targetDivision - Target division - * @param targetCity - Target city - * @param materialName - Name of the material - * @param amt - Amount of material to export. - */ - exportMaterial( - sourceDivision: string, - sourceCity: CityName | `${CityName}`, - targetDivision: string, - targetCity: CityName | `${CityName}`, - materialName: string, - amt: number, - ): void; - /** - * Cancel material export - * @param sourceDivision - Source division - * @param sourceCity - Source city - * @param targetDivision - Target division - * @param targetCity - Target city - * @param materialName - Name of the material - * @param amt - Amount of material to export. - */ - cancelExportMaterial( - sourceDivision: string, - sourceCity: CityName | `${CityName}`, - targetDivision: string, - targetCity: CityName | `${CityName}`, - materialName: string, - amt: number, - ): void; - /** - * Purchase warehouse for a new city - * @param divisionName - Name of the division - * @param city - Name of the city - */ - purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; - /** - * Upgrade warehouse - * @param divisionName - Name of the division - * @param city - Name of the city - * @param amt - amount of upgrades defaults to 1 - */ - upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: number): void; - /** - * Create a new product - * @param divisionName - Name of the division - * @param city - Name of the city - * @param productName - Name of the product - * @param designInvest - Amount to invest for the design of the product. - * @param marketingInvest - Amount to invest for the marketing of the product. - */ - makeProduct( - divisionName: string, - city: CityName | `${CityName}`, - productName: string, - designInvest: number, - marketingInvest: number, - ): void; - /** - * Limit Material Production. - * @param divisionName - Name of the division. - * @param city - Name of the city. - * @param materialName - Name of the material. - * @param qty - Amount to limit to. Pass a negative value to remove the limit instead. - */ - limitMaterialProduction( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - qty: number, - ): void; - /** - * Limit Product Production. - * @param divisionName - Name of the division. - * @param city - Name of the city. - * @param productName - Name of the product. - * @param qty - Amount to limit to. Pass a negative value to remove the limit instead. - */ - limitProductProduction(divisionName: string, city: CityName | `${CityName}`, productName: string, qty: number): void; - /** - * Gets the cost to upgrade a warehouse to the next level - * @param divisionName - Name of the division - * @param city - Name of the city - * @param amt - amount of upgrades. Optional, defaults to 1 - * @returns cost to upgrade - */ - getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, amt?: number): number; - /** - * Check if you have a warehouse in city - * @returns true if warehouse is present, false if not - */ - hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; -} - -/** - * Work formulas - * @public - */ -export declare interface WorkFormulas { - crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number; - /** @returns The WorkStats gained when completing one instance of the specified crime. */ - crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; - /** @returns The WorkStats applied every game cycle (200ms) by taking the specified gym class. */ - gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: string): WorkStats; - /** @returns The WorkStats applied every game cycle (200ms) by taking the specified university class. */ - universityGains( - person: Person, - classType: UniversityClassType | `${UniversityClassType}`, - locationName: string, - ): WorkStats; - /** @returns The WorkStats applied every game cycle (200ms) by performing the specified faction work. */ - factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats; - /** @returns The WorkStats applied every game cycle (200ms) by performing the specified company work. */ - companyGains(person: Person, companyName: string, workType: JobName | `${JobName}`, favor: number): WorkStats; -} - -/** @public */ -export declare interface WorkStats { - money: number; - reputation: number; - hackExp: number; - strExp: number; - defExp: number; - dexExp: number; - agiExp: number; - chaExp: number; - intExp: number; -} - -export { } diff --git a/dist/images/297df8c0e47764ea113951318b2acf55.png b/dist/images/297df8c0e47764ea113951318b2acf55.png deleted file mode 100644 index 325587072..000000000 Binary files a/dist/images/297df8c0e47764ea113951318b2acf55.png and /dev/null differ diff --git a/dist/images/447bc31e61f55e7eff875be3e9a81f1a.png b/dist/images/447bc31e61f55e7eff875be3e9a81f1a.png deleted file mode 100644 index 7a418256c..000000000 Binary files a/dist/images/447bc31e61f55e7eff875be3e9a81f1a.png and /dev/null differ diff --git a/dist/images/4e0e750f2f09de58219773edd46cbbf5.png b/dist/images/4e0e750f2f09de58219773edd46cbbf5.png deleted file mode 100644 index c8cf0257c..000000000 Binary files a/dist/images/4e0e750f2f09de58219773edd46cbbf5.png and /dev/null differ diff --git a/dist/images/5aa87b7de67a77c914088783b055e1cf.png b/dist/images/5aa87b7de67a77c914088783b055e1cf.png deleted file mode 100644 index d74fcec6c..000000000 Binary files a/dist/images/5aa87b7de67a77c914088783b055e1cf.png and /dev/null differ diff --git a/dist/images/66f4b86d86164fc117bd6d648e4eaa6f.png b/dist/images/66f4b86d86164fc117bd6d648e4eaa6f.png deleted file mode 100644 index 9233080f3..000000000 Binary files a/dist/images/66f4b86d86164fc117bd6d648e4eaa6f.png and /dev/null differ diff --git a/dist/images/6caf35202b10b52e1fc2743f674c33e8.png b/dist/images/6caf35202b10b52e1fc2743f674c33e8.png deleted file mode 100644 index e9c348227..000000000 Binary files a/dist/images/6caf35202b10b52e1fc2743f674c33e8.png and /dev/null differ diff --git a/dist/images/83b2443ab7e7d346766c8f6bc5afc7a7.png b/dist/images/83b2443ab7e7d346766c8f6bc5afc7a7.png deleted file mode 100644 index bc32b47aa..000000000 Binary files a/dist/images/83b2443ab7e7d346766c8f6bc5afc7a7.png and /dev/null differ diff --git a/dist/images/85a7b2896acb62be76f3ea7100fe9012.png b/dist/images/85a7b2896acb62be76f3ea7100fe9012.png deleted file mode 100644 index 3b3cc2456..000000000 Binary files a/dist/images/85a7b2896acb62be76f3ea7100fe9012.png and /dev/null differ diff --git a/dist/images/9f96a5084f4e5f1a6c0041b41b34d62d.png b/dist/images/9f96a5084f4e5f1a6c0041b41b34d62d.png deleted file mode 100644 index 9e3040dce..000000000 Binary files a/dist/images/9f96a5084f4e5f1a6c0041b41b34d62d.png and /dev/null differ diff --git a/dist/images/a1110d6c8d16a14c4570411750248399.png b/dist/images/a1110d6c8d16a14c4570411750248399.png deleted file mode 100644 index 16b9ef558..000000000 Binary files a/dist/images/a1110d6c8d16a14c4570411750248399.png and /dev/null differ diff --git a/dist/images/c7164b072d62c91c27c6d607b5207e7b.png b/dist/images/c7164b072d62c91c27c6d607b5207e7b.png deleted file mode 100644 index 51264adb1..000000000 Binary files a/dist/images/c7164b072d62c91c27c6d607b5207e7b.png and /dev/null differ diff --git a/dist/images/cb88977ea837bccb9cceb727adc78302.png b/dist/images/cb88977ea837bccb9cceb727adc78302.png deleted file mode 100644 index be9f68545..000000000 Binary files a/dist/images/cb88977ea837bccb9cceb727adc78302.png and /dev/null differ diff --git a/dist/images/e66b0c327f97d08e4253f52234d659eb.png b/dist/images/e66b0c327f97d08e4253f52234d659eb.png deleted file mode 100644 index 3f03552d7..000000000 Binary files a/dist/images/e66b0c327f97d08e4253f52234d659eb.png and /dev/null differ diff --git a/dist/images/e97de4daa946331c7e99dee9c05d629c.png b/dist/images/e97de4daa946331c7e99dee9c05d629c.png deleted file mode 100644 index 44324a041..000000000 Binary files a/dist/images/e97de4daa946331c7e99dee9c05d629c.png and /dev/null differ diff --git a/markdown/bitburner.activefragment.highestcharge.md b/markdown/bitburner.activefragment.highestcharge.md index d96c88926..dffb33051 100644 --- a/markdown/bitburner.activefragment.highestcharge.md +++ b/markdown/bitburner.activefragment.highestcharge.md @@ -4,7 +4,7 @@ ## ActiveFragment.highestCharge property -Signature: +**Signature:** ```typescript highestCharge: number; diff --git a/markdown/bitburner.activefragment.id.md b/markdown/bitburner.activefragment.id.md index 8f5a71af1..7526bc62f 100644 --- a/markdown/bitburner.activefragment.id.md +++ b/markdown/bitburner.activefragment.id.md @@ -4,7 +4,7 @@ ## ActiveFragment.id property -Signature: +**Signature:** ```typescript id: number; diff --git a/markdown/bitburner.activefragment.md b/markdown/bitburner.activefragment.md index 952baba26..44c8fd1f1 100644 --- a/markdown/bitburner.activefragment.md +++ b/markdown/bitburner.activefragment.md @@ -5,7 +5,7 @@ ## ActiveFragment interface -Signature: +**Signature:** ```typescript interface ActiveFragment @@ -13,12 +13,12 @@ interface ActiveFragment ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [highestCharge](./bitburner.activefragment.highestcharge.md) | number | | -| [id](./bitburner.activefragment.id.md) | number | | -| [numCharge](./bitburner.activefragment.numcharge.md) | number | | -| [rotation](./bitburner.activefragment.rotation.md) | number | | -| [x](./bitburner.activefragment.x.md) | number | | -| [y](./bitburner.activefragment.y.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [highestCharge](./bitburner.activefragment.highestcharge.md) | | number | | +| [id](./bitburner.activefragment.id.md) | | number | | +| [numCharge](./bitburner.activefragment.numcharge.md) | | number | | +| [rotation](./bitburner.activefragment.rotation.md) | | number | | +| [x](./bitburner.activefragment.x.md) | | number | | +| [y](./bitburner.activefragment.y.md) | | number | | diff --git a/markdown/bitburner.activefragment.numcharge.md b/markdown/bitburner.activefragment.numcharge.md index a5bab3eb2..227cc3599 100644 --- a/markdown/bitburner.activefragment.numcharge.md +++ b/markdown/bitburner.activefragment.numcharge.md @@ -4,7 +4,7 @@ ## ActiveFragment.numCharge property -Signature: +**Signature:** ```typescript numCharge: number; diff --git a/markdown/bitburner.activefragment.rotation.md b/markdown/bitburner.activefragment.rotation.md index 6e0c81e88..07a00c65e 100644 --- a/markdown/bitburner.activefragment.rotation.md +++ b/markdown/bitburner.activefragment.rotation.md @@ -4,7 +4,7 @@ ## ActiveFragment.rotation property -Signature: +**Signature:** ```typescript rotation: number; diff --git a/markdown/bitburner.activefragment.x.md b/markdown/bitburner.activefragment.x.md index 47a481c94..9624b608d 100644 --- a/markdown/bitburner.activefragment.x.md +++ b/markdown/bitburner.activefragment.x.md @@ -4,7 +4,7 @@ ## ActiveFragment.x property -Signature: +**Signature:** ```typescript x: number; diff --git a/markdown/bitburner.activefragment.y.md b/markdown/bitburner.activefragment.y.md index 93582014f..e93ba397e 100644 --- a/markdown/bitburner.activefragment.y.md +++ b/markdown/bitburner.activefragment.y.md @@ -4,7 +4,7 @@ ## ActiveFragment.y property -Signature: +**Signature:** ```typescript y: number; diff --git a/markdown/bitburner.augmentpair.cost.md b/markdown/bitburner.augmentpair.cost.md index f165f095b..99fc86e5e 100644 --- a/markdown/bitburner.augmentpair.cost.md +++ b/markdown/bitburner.augmentpair.cost.md @@ -6,7 +6,7 @@ augmentation cost -Signature: +**Signature:** ```typescript cost: number; diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md index c78d64415..d044376b8 100644 --- a/markdown/bitburner.augmentpair.md +++ b/markdown/bitburner.augmentpair.md @@ -6,7 +6,7 @@ Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) -Signature: +**Signature:** ```typescript interface AugmentPair @@ -14,8 +14,8 @@ interface AugmentPair ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost | -| [name](./bitburner.augmentpair.name.md) | string | augmentation name | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cost](./bitburner.augmentpair.cost.md) | | number | augmentation cost | +| [name](./bitburner.augmentpair.name.md) | | string | augmentation name | diff --git a/markdown/bitburner.augmentpair.name.md b/markdown/bitburner.augmentpair.name.md index 095ac60b7..979251aab 100644 --- a/markdown/bitburner.augmentpair.name.md +++ b/markdown/bitburner.augmentpair.name.md @@ -6,7 +6,7 @@ augmentation name -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.autocompletedata.flags.md b/markdown/bitburner.autocompletedata.flags.md index d0ecfc3f4..575e5f270 100644 --- a/markdown/bitburner.autocompletedata.flags.md +++ b/markdown/bitburner.autocompletedata.flags.md @@ -4,7 +4,7 @@ ## AutocompleteData.flags() method -Signature: +**Signature:** ```typescript flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; @@ -16,7 +16,7 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string] | --- | --- | --- | | schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | -Returns: +**Returns:** { \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] } diff --git a/markdown/bitburner.autocompletedata.md b/markdown/bitburner.autocompletedata.md index 459b3c07a..444e79449 100644 --- a/markdown/bitburner.autocompletedata.md +++ b/markdown/bitburner.autocompletedata.md @@ -6,7 +6,7 @@ Used for autocompletion -Signature: +**Signature:** ```typescript interface AutocompleteData @@ -14,11 +14,11 @@ interface AutocompleteData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [scripts](./bitburner.autocompletedata.scripts.md) | string\[\] | | -| [servers](./bitburner.autocompletedata.servers.md) | string\[\] | | -| [txts](./bitburner.autocompletedata.txts.md) | string\[\] | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [scripts](./bitburner.autocompletedata.scripts.md) | | string\[\] | | +| [servers](./bitburner.autocompletedata.servers.md) | | string\[\] | | +| [txts](./bitburner.autocompletedata.txts.md) | | string\[\] | | ## Methods diff --git a/markdown/bitburner.autocompletedata.scripts.md b/markdown/bitburner.autocompletedata.scripts.md index a61e16e63..61bb0f095 100644 --- a/markdown/bitburner.autocompletedata.scripts.md +++ b/markdown/bitburner.autocompletedata.scripts.md @@ -4,7 +4,7 @@ ## AutocompleteData.scripts property -Signature: +**Signature:** ```typescript scripts: string[]; diff --git a/markdown/bitburner.autocompletedata.servers.md b/markdown/bitburner.autocompletedata.servers.md index c54df9876..c54c0f26a 100644 --- a/markdown/bitburner.autocompletedata.servers.md +++ b/markdown/bitburner.autocompletedata.servers.md @@ -4,7 +4,7 @@ ## AutocompleteData.servers property -Signature: +**Signature:** ```typescript servers: string[]; diff --git a/markdown/bitburner.autocompletedata.txts.md b/markdown/bitburner.autocompletedata.txts.md index 0b8d0776d..37e552011 100644 --- a/markdown/bitburner.autocompletedata.txts.md +++ b/markdown/bitburner.autocompletedata.txts.md @@ -4,7 +4,7 @@ ## AutocompleteData.txts property -Signature: +**Signature:** ```typescript txts: string[]; diff --git a/markdown/bitburner.basichgwoptions.md b/markdown/bitburner.basichgwoptions.md index b56b86809..a64aede96 100644 --- a/markdown/bitburner.basichgwoptions.md +++ b/markdown/bitburner.basichgwoptions.md @@ -6,7 +6,7 @@ Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). -Signature: +**Signature:** ```typescript interface BasicHGWOptions @@ -14,8 +14,8 @@ interface BasicHGWOptions ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [stock?](./bitburner.basichgwoptions.stock.md) | boolean | (Optional) Set to true this action will affect the stock market. | -| [threads?](./bitburner.basichgwoptions.threads.md) | number | (Optional) Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [stock?](./bitburner.basichgwoptions.stock.md) | | boolean | _(Optional)_ Set to true this action will affect the stock market. | +| [threads?](./bitburner.basichgwoptions.threads.md) | | number | _(Optional)_ 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.stock.md b/markdown/bitburner.basichgwoptions.stock.md index 07641f528..29d62eb40 100644 --- a/markdown/bitburner.basichgwoptions.stock.md +++ b/markdown/bitburner.basichgwoptions.stock.md @@ -6,7 +6,7 @@ Set to true this action will affect the stock market. -Signature: +**Signature:** ```typescript stock?: boolean; diff --git a/markdown/bitburner.basichgwoptions.threads.md b/markdown/bitburner.basichgwoptions.threads.md index b13188693..930148b66 100644 --- a/markdown/bitburner.basichgwoptions.threads.md +++ b/markdown/bitburner.basichgwoptions.threads.md @@ -6,7 +6,7 @@ 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: +**Signature:** ```typescript threads?: number; diff --git a/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md index c142d8512..3b4e4c5b9 100644 --- a/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's agility level (not exp) scales -Signature: +**Signature:** ```typescript AgilityLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md index ef89b6397..8387510a1 100644 --- a/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md +++ b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md @@ -6,7 +6,7 @@ Influences the base cost to purchase an augmentation. -Signature: +**Signature:** ```typescript AugmentationMoneyCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md index 4022dede5..3cecb7492 100644 --- a/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md +++ b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md @@ -6,7 +6,7 @@ Influences the base rep the player must have with a faction to purchase an augmentation. -Signature: +**Signature:** ```typescript AugmentationRepCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md index 32493fb37..98e7ef7f8 100644 --- a/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md @@ -6,7 +6,7 @@ Influences how quickly the player can gain rank within Bladeburner. -Signature: +**Signature:** ```typescript BladeburnerRank: number; diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md index cd881ac4b..84656071f 100644 --- a/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md @@ -6,7 +6,7 @@ Influences the cost of skill levels from Bladeburner. -Signature: +**Signature:** ```typescript BladeburnerSkillCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md index 9b1baa72d..744000188 100644 --- a/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's charisma level (not exp) scales -Signature: +**Signature:** ```typescript CharismaLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.classgymexpgain.md b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md index 91cfa80cb..4b5ae232c 100644 --- a/markdown/bitburner.bitnodemultipliers.classgymexpgain.md +++ b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md @@ -6,7 +6,7 @@ Influences the experience gained for each ability when a player completes a class. -Signature: +**Signature:** ```typescript ClassGymExpGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md index dab83a4f6..a0eea9f25 100644 --- a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md +++ b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md @@ -6,7 +6,7 @@ Influences the amount of money gained from completing Coding Contracts -Signature: +**Signature:** ```typescript CodingContractMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md index d24fed4b2..f8901e4c0 100644 --- a/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md +++ b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md @@ -6,7 +6,7 @@ Influences the experience gained for each ability when the player completes working their job. -Signature: +**Signature:** ```typescript CompanyWorkExpGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.companyworkmoney.md b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md index be534d6c3..f6b26d927 100644 --- a/markdown/bitburner.bitnodemultipliers.companyworkmoney.md +++ b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md @@ -6,7 +6,7 @@ Influences how much money the player earns when completing working their job. -Signature: +**Signature:** ```typescript CompanyWorkMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md index 603383abf..0ff2d2284 100644 --- a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md +++ b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md @@ -6,7 +6,7 @@ Influences the money gain from dividends of corporations created by the player. -Signature: +**Signature:** ```typescript CorporationSoftcap: number; diff --git a/markdown/bitburner.bitnodemultipliers.corporationvaluation.md b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md index b9be862b8..6bc8c3830 100644 --- a/markdown/bitburner.bitnodemultipliers.corporationvaluation.md +++ b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md @@ -6,7 +6,7 @@ Influences the valuation of corporations created by the player. -Signature: +**Signature:** ```typescript CorporationValuation: number; diff --git a/markdown/bitburner.bitnodemultipliers.crimeexpgain.md b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md index 472819f16..4bf0cc89c 100644 --- a/markdown/bitburner.bitnodemultipliers.crimeexpgain.md +++ b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md @@ -6,7 +6,7 @@ Influences the base experience gained for each ability when the player commits a crime. -Signature: +**Signature:** ```typescript CrimeExpGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.crimemoney.md b/markdown/bitburner.bitnodemultipliers.crimemoney.md index c3fffbdac..a6bf6b3f0 100644 --- a/markdown/bitburner.bitnodemultipliers.crimemoney.md +++ b/markdown/bitburner.bitnodemultipliers.crimemoney.md @@ -6,7 +6,7 @@ Influences the base money gained when the player commits a crime. -Signature: +**Signature:** ```typescript CrimeMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md index b16ad9a81..098ed046c 100644 --- a/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md +++ b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md @@ -6,7 +6,7 @@ Influences how many Augmentations you need in order to get invited to the Daedalus faction -Signature: +**Signature:** ```typescript DaedalusAugsRequirement: number; diff --git a/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md index 6ae574d3c..eb3e50f8f 100644 --- a/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's defense level (not exp) scales -Signature: +**Signature:** ```typescript DefenseLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md index 2d1c6f2db..21d5d7736 100644 --- a/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's dexterity level (not exp) scales -Signature: +**Signature:** ```typescript DexterityLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md index 0ae7112d6..e8d4f2397 100644 --- a/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md +++ b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md @@ -6,7 +6,7 @@ Influences how much rep the player gains in each faction simply by being a member. -Signature: +**Signature:** ```typescript FactionPassiveRepGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md index 0c248a1b9..c938fc448 100644 --- a/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md +++ b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md @@ -6,7 +6,7 @@ Influences the experience gained for each ability when the player completes work for a Faction. -Signature: +**Signature:** ```typescript FactionWorkExpGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md index 7de8b0d31..34731ce3a 100644 --- a/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md +++ b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md @@ -6,7 +6,7 @@ Influences how much rep the player gains when performing work for a faction. -Signature: +**Signature:** ```typescript FactionWorkRepGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md index 640bc066a..829ace8be 100644 --- a/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md @@ -6,7 +6,7 @@ Influences how much it costs to unlock the stock market's 4S Market Data API -Signature: +**Signature:** ```typescript FourSigmaMarketDataApiCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md index 781f09ad3..1612eaebb 100644 --- a/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md @@ -6,7 +6,7 @@ Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) -Signature: +**Signature:** ```typescript FourSigmaMarketDataCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.gangsoftcap.md b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md index 39e80cbcd..b0a145130 100644 --- a/markdown/bitburner.bitnodemultipliers.gangsoftcap.md +++ b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md @@ -6,7 +6,7 @@ Influences the respect gain and money gain of your gang. -Signature: +**Signature:** ```typescript GangSoftcap: number; diff --git a/markdown/bitburner.bitnodemultipliers.hackexpgain.md b/markdown/bitburner.bitnodemultipliers.hackexpgain.md index b31f69168..79ba4e202 100644 --- a/markdown/bitburner.bitnodemultipliers.hackexpgain.md +++ b/markdown/bitburner.bitnodemultipliers.hackexpgain.md @@ -6,7 +6,7 @@ Influences the experienced gained when hacking a server. -Signature: +**Signature:** ```typescript HackExpGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md index ae7779522..a0ce2c076 100644 --- a/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's hacking level (not experience) scales -Signature: +**Signature:** ```typescript HackingLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md index 314143a8f..cb2899c16 100644 --- a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md +++ b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md @@ -6,7 +6,7 @@ Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) -Signature: +**Signature:** ```typescript HacknetNodeMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md index b911069be..1d001c829 100644 --- a/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md +++ b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md @@ -6,7 +6,7 @@ Influences how much money it costs to upgrade your home computer's RAM -Signature: +**Signature:** ```typescript HomeComputerRamCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md index 60a00b135..d309bd940 100644 --- a/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md +++ b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md @@ -6,7 +6,7 @@ Influences how much money is gained when the player infiltrates a company. -Signature: +**Signature:** ```typescript InfiltrationMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationrep.md b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md index 7c357559c..450d6aaf9 100644 --- a/markdown/bitburner.bitnodemultipliers.infiltrationrep.md +++ b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md @@ -6,7 +6,7 @@ Influences how much rep the player can gain from factions when selling stolen documents and secrets -Signature: +**Signature:** ```typescript InfiltrationRep: number; diff --git a/markdown/bitburner.bitnodemultipliers.manualhackmoney.md b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md index ed941abf9..28270002e 100644 --- a/markdown/bitburner.bitnodemultipliers.manualhackmoney.md +++ b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md @@ -6,7 +6,7 @@ Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. -Signature: +**Signature:** ```typescript ManualHackMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md index fc15711f2..68cedb90a 100644 --- a/markdown/bitburner.bitnodemultipliers.md +++ b/markdown/bitburner.bitnodemultipliers.md @@ -6,7 +6,7 @@ All multipliers affecting the difficulty of the current challenge. -Signature: +**Signature:** ```typescript interface BitNodeMultipliers @@ -14,52 +14,52 @@ 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. | -| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | number | Influences the money gain from dividends of corporations created by the player. | -| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | number | Influences the valuation of corporations created by the player. | -| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | number | Influences the base experience gained for each ability when the player commits a crime. | -| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | number | Influences the base money gained when the player commits a crime. | -| [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) | -| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | number | Influences the respect gain and money gain of your gang. | -| [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 | -| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | number | Influences cost of any purchased server at or above 128GB | -| [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 the money on a server can be reduced when a script performs a hack against it. | -| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. | -| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. | -| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maximum money that a server can grow to. | -| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. | -| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. | -| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. | -| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | number | Influences the size of the gift | -| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | number | Influences the power of the gift | -| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | number | Influences how quickly the player's strength level (not exp) scales | -| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | number | Influences the hacking skill required to backdoor the world daemon. | +| Property | Modifiers | 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. | +| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | | number | Influences the money gain from dividends of corporations created by the player. | +| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | | number | Influences the valuation of corporations created by the player. | +| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | | number | Influences the base experience gained for each ability when the player commits a crime. | +| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | | number | Influences the base money gained when the player commits a crime. | +| [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) | +| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | | number | Influences the respect gain and money gain of your gang. | +| [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 | +| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | | number | Influences cost of any purchased server at or above 128GB | +| [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 the money on a server can be reduced when a script performs a hack against it. | +| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. | +| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | | number | Influences the growth percentage per cycle against a server. | +| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | | number | Influences the maximum money that a server can grow to. | +| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | | number | Influences the initial money that a server starts with. | +| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | | number | Influences the initial security level (hackDifficulty) of a server. | +| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | | number | Influences the weaken amount per invocation against a server. | +| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | | number | Influences the size of the gift | +| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | | number | Influences the power of the gift | +| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | | number | Influences how quickly the player's strength level (not exp) scales | +| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | | number | Influences the hacking skill required to backdoor the world daemon. | diff --git a/markdown/bitburner.bitnodemultipliers.purchasedservercost.md b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md index 3881f4ba7..026cd00ae 100644 --- a/markdown/bitburner.bitnodemultipliers.purchasedservercost.md +++ b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md @@ -6,7 +6,7 @@ Influence how much it costs to purchase a server -Signature: +**Signature:** ```typescript PurchasedServerCost: number; diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md index fdaf15067..e73e1ee22 100644 --- a/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md +++ b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md @@ -6,7 +6,7 @@ Influences the maximum number of purchased servers you can have -Signature: +**Signature:** ```typescript PurchasedServerLimit: number; diff --git a/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md index 91913734c..daedd5a30 100644 --- a/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md +++ b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md @@ -6,7 +6,7 @@ Influences the maximum allowed RAM for a purchased server -Signature: +**Signature:** ```typescript PurchasedServerMaxRam: number; diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md index 5f8e251e3..23786f7cf 100644 --- a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md +++ b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md @@ -6,7 +6,7 @@ Influences cost of any purchased server at or above 128GB -Signature: +**Signature:** ```typescript PurchasedServerSoftcap: number; diff --git a/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md index 35f28e704..acbed2524 100644 --- a/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md +++ b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md @@ -6,7 +6,7 @@ Influences the minimum favor the player must have with a faction before they can donate to gain rep. -Signature: +**Signature:** ```typescript RepToDonateToFaction: number; diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md index c0fb0e02b..0b94ca152 100644 --- a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md @@ -6,7 +6,7 @@ Influences how much the money on a server can be reduced when a script performs a hack against it. -Signature: +**Signature:** ```typescript ScriptHackMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md index 38b82f966..a2d67aa72 100644 --- a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md @@ -6,7 +6,7 @@ Influences how much of the money stolen by a scripted hack will be added to the player's money. -Signature: +**Signature:** ```typescript ScriptHackMoneyGain: number; diff --git a/markdown/bitburner.bitnodemultipliers.servergrowthrate.md b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md index 0f27490f1..7a7caf06b 100644 --- a/markdown/bitburner.bitnodemultipliers.servergrowthrate.md +++ b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md @@ -6,7 +6,7 @@ Influences the growth percentage per cycle against a server. -Signature: +**Signature:** ```typescript ServerGrowthRate: number; diff --git a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md index 103d38bf7..4465e2db3 100644 --- a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md +++ b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md @@ -6,7 +6,7 @@ Influences the maximum money that a server can grow to. -Signature: +**Signature:** ```typescript ServerMaxMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md index c7455592e..7f225217c 100644 --- a/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md +++ b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md @@ -6,7 +6,7 @@ Influences the initial money that a server starts with. -Signature: +**Signature:** ```typescript ServerStartingMoney: number; diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md index 85eed7975..b1018bc5c 100644 --- a/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md +++ b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md @@ -6,7 +6,7 @@ Influences the initial security level (hackDifficulty) of a server. -Signature: +**Signature:** ```typescript ServerStartingSecurity: number; diff --git a/markdown/bitburner.bitnodemultipliers.serverweakenrate.md b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md index 152821446..042ba37fc 100644 --- a/markdown/bitburner.bitnodemultipliers.serverweakenrate.md +++ b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md @@ -6,7 +6,7 @@ Influences the weaken amount per invocation against a server. -Signature: +**Signature:** ```typescript ServerWeakenRate: number; diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md index 8854881a4..0facd2693 100644 --- a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md @@ -6,7 +6,7 @@ Influences the size of the gift -Signature: +**Signature:** ```typescript StaneksGiftExtraSize: number; diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md index aba511247..1bc5a6069 100644 --- a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md @@ -6,7 +6,7 @@ Influences the power of the gift -Signature: +**Signature:** ```typescript StaneksGiftPowerMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md index 379d42239..d91864c0f 100644 --- a/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md +++ b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md @@ -6,7 +6,7 @@ Influences how quickly the player's strength level (not exp) scales -Signature: +**Signature:** ```typescript StrengthLevelMultiplier: number; diff --git a/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md index 883a1a6c2..37844310b 100644 --- a/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md +++ b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md @@ -6,7 +6,7 @@ Influences the hacking skill required to backdoor the world daemon. -Signature: +**Signature:** ```typescript WorldDaemonDifficulty: number; diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md index c9e7175e0..1a68f5429 100644 --- a/markdown/bitburner.bladeburner.getactionautolevel.md +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -6,7 +6,7 @@ Get whether an action is set to autolevel. -Signature: +**Signature:** ```typescript getActionAutolevel(type: string, name: string): boolean; @@ -19,7 +19,7 @@ getActionAutolevel(type: string, name: string): boolean; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index 5ceebf6f8..052ad6032 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -6,7 +6,7 @@ Get action count remaining. -Signature: +**Signature:** ```typescript getActionCountRemaining(type: string, name: string): number; @@ -19,7 +19,7 @@ getActionCountRemaining(type: string, name: string): number; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md index 07b232f72..384f3adb5 100644 --- a/markdown/bitburner.bladeburner.getactioncurrentlevel.md +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -6,7 +6,7 @@ Get the current level of an action. -Signature: +**Signature:** ```typescript getActionCurrentLevel(type: string, name: string): number; @@ -19,7 +19,7 @@ getActionCurrentLevel(type: string, name: string): number; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getactioncurrenttime.md b/markdown/bitburner.bladeburner.getactioncurrenttime.md index 8298d99a2..d1aa8c424 100644 --- a/markdown/bitburner.bladeburner.getactioncurrenttime.md +++ b/markdown/bitburner.bladeburner.getactioncurrenttime.md @@ -6,12 +6,12 @@ Get the time elapsed on current action. -Signature: +**Signature:** ```typescript getActionCurrentTime(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md index c6b480801..47eabb038 100644 --- a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -6,7 +6,7 @@ Get estimate success chance of an action. -Signature: +**Signature:** ```typescript getActionEstimatedSuccessChance(type: string, name: string): [number, number]; @@ -19,7 +19,7 @@ getActionEstimatedSuccessChance(type: string, name: string): [number, number]; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** \[number, number\] diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md index 5b4629ea5..dee2743eb 100644 --- a/markdown/bitburner.bladeburner.getactionmaxlevel.md +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -6,7 +6,7 @@ Get the maximum level of an action. -Signature: +**Signature:** ```typescript getActionMaxLevel(type: string, name: string): number; @@ -19,7 +19,7 @@ getActionMaxLevel(type: string, name: string): number; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md index 96bcc0f11..ea07e1342 100644 --- a/markdown/bitburner.bladeburner.getactionrepgain.md +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -6,7 +6,7 @@ Get the reputation gain of an action. -Signature: +**Signature:** ```typescript getActionRepGain(type: string, name: string, level: number): number; @@ -20,7 +20,7 @@ getActionRepGain(type: string, name: string, level: number): number; | name | string | Name of action. Must be an exact match. | | level | number | Optional action level at which to calculate the gain | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getactionsuccesses.md b/markdown/bitburner.bladeburner.getactionsuccesses.md new file mode 100644 index 000000000..349b243ad --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionsuccesses.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionSuccesses](./bitburner.bladeburner.getactionsuccesses.md) + +## Bladeburner.getActionSuccesses() method + +Get action successes. + +**Signature:** + +```typescript +getActionSuccesses(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +**Returns:** + +number + +a number with how many successes you have with action. + +## Remarks + +RAM cost: 4 GB + +Return a number with how many successes you have with action. + diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md index ef920eec4..08ac013ed 100644 --- a/markdown/bitburner.bladeburner.getactiontime.md +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -6,7 +6,7 @@ Get the time to complete an action. -Signature: +**Signature:** ```typescript getActionTime(type: string, name: string): number; @@ -19,7 +19,7 @@ getActionTime(type: string, name: string): number; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getblackopnames.md b/markdown/bitburner.bladeburner.getblackopnames.md index abd073e1a..3763d988c 100644 --- a/markdown/bitburner.bladeburner.getblackopnames.md +++ b/markdown/bitburner.bladeburner.getblackopnames.md @@ -6,12 +6,12 @@ List all black ops. -Signature: +**Signature:** ```typescript getBlackOpNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.bladeburner.getblackoprank.md b/markdown/bitburner.bladeburner.getblackoprank.md index cd05f50db..e4c87f7b6 100644 --- a/markdown/bitburner.bladeburner.getblackoprank.md +++ b/markdown/bitburner.bladeburner.getblackoprank.md @@ -6,7 +6,7 @@ Get black op required rank. -Signature: +**Signature:** ```typescript getBlackOpRank(name: string): number; @@ -18,7 +18,7 @@ getBlackOpRank(name: string): number; | --- | --- | --- | | name | string | Name of BlackOp. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getbonustime.md b/markdown/bitburner.bladeburner.getbonustime.md index 1135fdf83..8fc653e0e 100644 --- a/markdown/bitburner.bladeburner.getbonustime.md +++ b/markdown/bitburner.bladeburner.getbonustime.md @@ -6,12 +6,12 @@ Get bladeburner bonus time. -Signature: +**Signature:** ```typescript getBonusTime(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getcity.md b/markdown/bitburner.bladeburner.getcity.md index 0bb805701..49601f7f4 100644 --- a/markdown/bitburner.bladeburner.getcity.md +++ b/markdown/bitburner.bladeburner.getcity.md @@ -6,12 +6,12 @@ Get current city. -Signature: +**Signature:** ```typescript getCity(): CityName; ``` -Returns: +**Returns:** [CityName](./bitburner.cityname.md) diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md index e45cadb12..4787aea95 100644 --- a/markdown/bitburner.bladeburner.getcitychaos.md +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -6,7 +6,7 @@ Get chaos of a city. -Signature: +**Signature:** ```typescript getCityChaos(city: CityName | `${CityName}`): number; @@ -18,7 +18,7 @@ getCityChaos(city: CityName | `${CityName}`): number; | --- | --- | --- | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md index c01f3779f..c432d1435 100644 --- a/markdown/bitburner.bladeburner.getcitycommunities.md +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -6,7 +6,7 @@ Get number of communities in a city. -Signature: +**Signature:** ```typescript getCityCommunities(city: CityName | `${CityName}`): number; @@ -18,7 +18,7 @@ getCityCommunities(city: CityName | `${CityName}`): number; | --- | --- | --- | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md index 9b54667c9..3ca677225 100644 --- a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -6,7 +6,7 @@ Get estimated population in city. -Signature: +**Signature:** ```typescript getCityEstimatedPopulation(city: CityName | `${CityName}`): number; @@ -18,7 +18,7 @@ getCityEstimatedPopulation(city: CityName | `${CityName}`): number; | --- | --- | --- | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getcontractnames.md b/markdown/bitburner.bladeburner.getcontractnames.md index 9ea54b621..b77ada5fe 100644 --- a/markdown/bitburner.bladeburner.getcontractnames.md +++ b/markdown/bitburner.bladeburner.getcontractnames.md @@ -6,12 +6,12 @@ List all contracts. -Signature: +**Signature:** ```typescript getContractNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.bladeburner.getcurrentaction.md b/markdown/bitburner.bladeburner.getcurrentaction.md index a2a1b87d0..35b2e1cca 100644 --- a/markdown/bitburner.bladeburner.getcurrentaction.md +++ b/markdown/bitburner.bladeburner.getcurrentaction.md @@ -6,12 +6,12 @@ Get current action. -Signature: +**Signature:** ```typescript getCurrentAction(): BladeburnerCurAction; ``` -Returns: +**Returns:** [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) diff --git a/markdown/bitburner.bladeburner.getgeneralactionnames.md b/markdown/bitburner.bladeburner.getgeneralactionnames.md index 2786ddcc4..efe7b2be4 100644 --- a/markdown/bitburner.bladeburner.getgeneralactionnames.md +++ b/markdown/bitburner.bladeburner.getgeneralactionnames.md @@ -6,12 +6,12 @@ List all general actions. -Signature: +**Signature:** ```typescript getGeneralActionNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.bladeburner.getoperationnames.md b/markdown/bitburner.bladeburner.getoperationnames.md index 659f4718e..2352b3c84 100644 --- a/markdown/bitburner.bladeburner.getoperationnames.md +++ b/markdown/bitburner.bladeburner.getoperationnames.md @@ -6,12 +6,12 @@ List all operations. -Signature: +**Signature:** ```typescript getOperationNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.bladeburner.getrank.md b/markdown/bitburner.bladeburner.getrank.md index a3160bdb4..fe992bd17 100644 --- a/markdown/bitburner.bladeburner.getrank.md +++ b/markdown/bitburner.bladeburner.getrank.md @@ -6,12 +6,12 @@ Get player bladeburner rank. -Signature: +**Signature:** ```typescript getRank(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md index 2c797f083..27943b2c0 100644 --- a/markdown/bitburner.bladeburner.getskilllevel.md +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -6,7 +6,7 @@ Get skill level. -Signature: +**Signature:** ```typescript getSkillLevel(name: string): number; @@ -18,7 +18,7 @@ getSkillLevel(name: string): number; | --- | --- | --- | | name | string | | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getskillnames.md b/markdown/bitburner.bladeburner.getskillnames.md index 14df6f225..9cfd053b1 100644 --- a/markdown/bitburner.bladeburner.getskillnames.md +++ b/markdown/bitburner.bladeburner.getskillnames.md @@ -6,12 +6,12 @@ List all skills. -Signature: +**Signature:** ```typescript getSkillNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.bladeburner.getskillpoints.md b/markdown/bitburner.bladeburner.getskillpoints.md index 466f82b6c..b4405ec53 100644 --- a/markdown/bitburner.bladeburner.getskillpoints.md +++ b/markdown/bitburner.bladeburner.getskillpoints.md @@ -6,12 +6,12 @@ Get bladeburner skill points. -Signature: +**Signature:** ```typescript getSkillPoints(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md index 23986d91c..c2fa9960d 100644 --- a/markdown/bitburner.bladeburner.getskillupgradecost.md +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -6,7 +6,7 @@ Get cost to upgrade skill. -Signature: +**Signature:** ```typescript getSkillUpgradeCost(name: string, count?: number): number; @@ -17,9 +17,9 @@ getSkillUpgradeCost(name: string, count?: number): number; | Parameter | Type | Description | | --- | --- | --- | | name | string | | -| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. | +| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.getstamina.md b/markdown/bitburner.bladeburner.getstamina.md index eec7b7c4a..f3b0a374e 100644 --- a/markdown/bitburner.bladeburner.getstamina.md +++ b/markdown/bitburner.bladeburner.getstamina.md @@ -6,12 +6,12 @@ Get bladeburner stamina. -Signature: +**Signature:** ```typescript getStamina(): [number, number]; ``` -Returns: +**Returns:** \[number, number\] diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md index aa3d2da47..37c87b530 100644 --- a/markdown/bitburner.bladeburner.getteamsize.md +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -6,7 +6,7 @@ Get team size. -Signature: +**Signature:** ```typescript getTeamSize(type: string, name: string): number; @@ -19,7 +19,7 @@ getTeamSize(type: string, name: string): number; | type | string | Type of action. | | name | string | Name of action. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.inbladeburner.md b/markdown/bitburner.bladeburner.inbladeburner.md index d999a75dc..39bc9acff 100644 --- a/markdown/bitburner.bladeburner.inbladeburner.md +++ b/markdown/bitburner.bladeburner.inbladeburner.md @@ -6,12 +6,12 @@ Returns whether player is a member of bladeburner division. Does not require API access. -Signature: +**Signature:** ```typescript inBladeburner(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md index 649f72e32..80d22978e 100644 --- a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md +++ b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md @@ -6,12 +6,12 @@ Join the bladeburner division. -Signature: +**Signature:** ```typescript joinBladeburnerDivision(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md index d2db36826..2c13da424 100644 --- a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md +++ b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md @@ -6,12 +6,12 @@ Join the bladeburner faction. -Signature: +**Signature:** ```typescript joinBladeburnerFaction(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md index 0ea3ddb30..5a4aa9345 100644 --- a/markdown/bitburner.bladeburner.md +++ b/markdown/bitburner.bladeburner.md @@ -6,7 +6,7 @@ Bladeburner API -Signature: +**Signature:** ```typescript export interface Bladeburner @@ -27,6 +27,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have | [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. | | [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. | | [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. | +| [getActionSuccesses(type, name)](./bitburner.bladeburner.getactionsuccesses.md) | Get action successes. | | [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | Get the time to complete an action. | | [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | List all black ops. | | [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | Get black op required rank. | diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md index 73f708f0d..cdf91610a 100644 --- a/markdown/bitburner.bladeburner.setactionautolevel.md +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -6,7 +6,7 @@ Set an action autolevel. -Signature: +**Signature:** ```typescript setActionAutolevel(type: string, name: string, autoLevel: boolean): void; @@ -20,7 +20,7 @@ setActionAutolevel(type: string, name: string, autoLevel: boolean): void; | name | string | Name of action. Must be an exact match. | | autoLevel | boolean | Whether or not to autolevel this action | -Returns: +**Returns:** void diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md index 398bde4dd..df40e0a6b 100644 --- a/markdown/bitburner.bladeburner.setactionlevel.md +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -6,7 +6,7 @@ Set the level of an action. -Signature: +**Signature:** ```typescript setActionLevel(type: string, name: string, level: number): void; @@ -20,7 +20,7 @@ setActionLevel(type: string, name: string, level: number): void; | name | string | Name of action. Must be an exact match. | | level | number | Level to set this action to. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md index 13a848cbe..d70dec94e 100644 --- a/markdown/bitburner.bladeburner.setteamsize.md +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -6,7 +6,7 @@ Set team size. -Signature: +**Signature:** ```typescript setTeamSize(type: string, name: string, size: number): number; @@ -20,7 +20,7 @@ setTeamSize(type: string, name: string, size: number): number; | name | string | Name of action. Must be an exact match. | | size | number | Number of team members to set. Will be converted using Math.round(). | -Returns: +**Returns:** number diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md index 4d3af78db..988cbe550 100644 --- a/markdown/bitburner.bladeburner.startaction.md +++ b/markdown/bitburner.bladeburner.startaction.md @@ -6,7 +6,7 @@ Start an action. -Signature: +**Signature:** ```typescript startAction(type: string, name: string): boolean; @@ -19,7 +19,7 @@ startAction(type: string, name: string): boolean; | type | string | Type of action. | | name | string | Name of action. Must be an exact match | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.stopbladeburneraction.md b/markdown/bitburner.bladeburner.stopbladeburneraction.md index 2542767e6..ba710d60f 100644 --- a/markdown/bitburner.bladeburner.stopbladeburneraction.md +++ b/markdown/bitburner.bladeburner.stopbladeburneraction.md @@ -6,12 +6,12 @@ Stop current action. -Signature: +**Signature:** ```typescript stopBladeburnerAction(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md index 99962b1b3..71afd93b8 100644 --- a/markdown/bitburner.bladeburner.switchcity.md +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -6,7 +6,7 @@ Travel to another city in bladeburner. -Signature: +**Signature:** ```typescript switchCity(city: CityName | `${CityName}`): boolean; @@ -18,7 +18,7 @@ switchCity(city: CityName | `${CityName}`): boolean; | --- | --- | --- | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md index f404b8f64..12b80e599 100644 --- a/markdown/bitburner.bladeburner.upgradeskill.md +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -6,7 +6,7 @@ Upgrade skill. -Signature: +**Signature:** ```typescript upgradeSkill(name: string, count?: number): boolean; @@ -17,9 +17,9 @@ upgradeSkill(name: string, count?: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | name | string | | -| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. | +| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md index 596804d5f..880d4675a 100644 --- a/markdown/bitburner.bladeburnercuraction.md +++ b/markdown/bitburner.bladeburnercuraction.md @@ -6,7 +6,7 @@ Bladeburner current action. -Signature: +**Signature:** ```typescript interface BladeburnerCurAction @@ -14,8 +14,8 @@ interface BladeburnerCurAction ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [name](./bitburner.bladeburnercuraction.name.md) | string | Name of Action | -| [type](./bitburner.bladeburnercuraction.type.md) | string | Type of Action | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./bitburner.bladeburnercuraction.name.md) | | string | Name of Action | +| [type](./bitburner.bladeburnercuraction.type.md) | | string | Type of Action | diff --git a/markdown/bitburner.bladeburnercuraction.name.md b/markdown/bitburner.bladeburnercuraction.name.md index 3dbcfe79b..ab9483168 100644 --- a/markdown/bitburner.bladeburnercuraction.name.md +++ b/markdown/bitburner.bladeburnercuraction.name.md @@ -6,7 +6,7 @@ Name of Action -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.bladeburnercuraction.type.md b/markdown/bitburner.bladeburnercuraction.type.md index 63e21aec4..4f89aea18 100644 --- a/markdown/bitburner.bladeburnercuraction.type.md +++ b/markdown/bitburner.bladeburnercuraction.type.md @@ -6,7 +6,7 @@ Type of Action -Signature: +**Signature:** ```typescript type: string; diff --git a/markdown/bitburner.cityname.md b/markdown/bitburner.cityname.md index 2ee019716..5a3da78b3 100644 --- a/markdown/bitburner.cityname.md +++ b/markdown/bitburner.cityname.md @@ -6,7 +6,7 @@ Names of all cities -Signature: +**Signature:** ```typescript declare enum CityName diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md index 8372562f2..0f3f9bac6 100644 --- a/markdown/bitburner.codingcontract.attempt.md +++ b/markdown/bitburner.codingcontract.attempt.md @@ -6,7 +6,7 @@ Attempts a coding contract, returning a reward string on success or empty string on failure. -Signature: +**Signature:** ```typescript attempt(answer: string | number | any[], filename: string, host?: string): string; @@ -18,9 +18,9 @@ attempt(answer: string | number | any[], filename: string, host?: string): strin | --- | --- | --- | | answer | string \| number \| any\[\] | Attempted solution for the contract. | | filename | string | Filename of the contract. | -| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | _(Optional)_ Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.codingcontract.createdummycontract.md b/markdown/bitburner.codingcontract.createdummycontract.md index 3b8520779..c4405a3ac 100644 --- a/markdown/bitburner.codingcontract.createdummycontract.md +++ b/markdown/bitburner.codingcontract.createdummycontract.md @@ -6,7 +6,7 @@ Generate a dummy contract. -Signature: +**Signature:** ```typescript createDummyContract(type: string): void; @@ -18,7 +18,7 @@ createDummyContract(type: string): void; | --- | --- | --- | | type | string | Type of contract to generate | -Returns: +**Returns:** void diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md index 686bfa3db..03468421b 100644 --- a/markdown/bitburner.codingcontract.getcontracttype.md +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -6,7 +6,7 @@ Get the type of a coding contract. -Signature: +**Signature:** ```typescript getContractType(filename: string, host?: string): string; @@ -17,9 +17,9 @@ getContractType(filename: string, host?: string): string; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of the contract. | -| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | _(Optional)_ Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.codingcontract.getcontracttypes.md b/markdown/bitburner.codingcontract.getcontracttypes.md index c688b7b96..09f56f95c 100644 --- a/markdown/bitburner.codingcontract.getcontracttypes.md +++ b/markdown/bitburner.codingcontract.getcontracttypes.md @@ -6,12 +6,12 @@ List all contract types. -Signature: +**Signature:** ```typescript getContractTypes(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.codingcontract.getdata.md b/markdown/bitburner.codingcontract.getdata.md index 703f25372..4f744ef27 100644 --- a/markdown/bitburner.codingcontract.getdata.md +++ b/markdown/bitburner.codingcontract.getdata.md @@ -6,7 +6,7 @@ Get the input data. -Signature: +**Signature:** ```typescript getData(filename: string, host?: string): CodingContractData; @@ -17,9 +17,9 @@ getData(filename: string, host?: string): CodingContractData; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of the contract. | -| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | _(Optional)_ Host of the server containing the contract. Optional. Defaults to current server if not provided. | -Returns: +**Returns:** [CodingContractData](./bitburner.codingcontractdata.md) diff --git a/markdown/bitburner.codingcontract.getdescription.md b/markdown/bitburner.codingcontract.getdescription.md index 86ab2f16c..3fcfb4ae3 100644 --- a/markdown/bitburner.codingcontract.getdescription.md +++ b/markdown/bitburner.codingcontract.getdescription.md @@ -6,7 +6,7 @@ Get the description. -Signature: +**Signature:** ```typescript getDescription(filename: string, host?: string): string; @@ -17,9 +17,9 @@ getDescription(filename: string, host?: string): string; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of the contract. | -| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | _(Optional)_ Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.codingcontract.getnumtriesremaining.md b/markdown/bitburner.codingcontract.getnumtriesremaining.md index f2be5a0bd..821734b69 100644 --- a/markdown/bitburner.codingcontract.getnumtriesremaining.md +++ b/markdown/bitburner.codingcontract.getnumtriesremaining.md @@ -6,7 +6,7 @@ Get the number of attempts remaining. -Signature: +**Signature:** ```typescript getNumTriesRemaining(filename: string, host?: string): number; @@ -17,9 +17,9 @@ getNumTriesRemaining(filename: string, host?: string): number; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of the contract. | -| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | _(Optional)_ Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md index ed16e523f..e32a0bfdf 100644 --- a/markdown/bitburner.codingcontract.md +++ b/markdown/bitburner.codingcontract.md @@ -6,7 +6,7 @@ Coding Contract API -Signature: +**Signature:** ```typescript export interface CodingContract diff --git a/markdown/bitburner.codingcontractdata.md b/markdown/bitburner.codingcontractdata.md index 5d237f0c4..8351e524a 100644 --- a/markdown/bitburner.codingcontractdata.md +++ b/markdown/bitburner.codingcontractdata.md @@ -6,7 +6,7 @@ Coding contract data will differ depending on coding contract. -Signature: +**Signature:** ```typescript type CodingContractData = any; diff --git a/markdown/bitburner.corpconstants.baseproductprofitmult.md b/markdown/bitburner.corpconstants.baseproductprofitmult.md index 9c45026ac..97f8b6c04 100644 --- a/markdown/bitburner.corpconstants.baseproductprofitmult.md +++ b/markdown/bitburner.corpconstants.baseproductprofitmult.md @@ -4,7 +4,7 @@ ## CorpConstants.baseProductProfitMult property -Signature: +**Signature:** ```typescript baseProductProfitMult: number; diff --git a/markdown/bitburner.corpconstants.bribeamountperreputation.md b/markdown/bitburner.corpconstants.bribeamountperreputation.md index ac9f5a57f..028d73f9c 100644 --- a/markdown/bitburner.corpconstants.bribeamountperreputation.md +++ b/markdown/bitburner.corpconstants.bribeamountperreputation.md @@ -4,7 +4,7 @@ ## CorpConstants.bribeAmountPerReputation property -Signature: +**Signature:** ```typescript bribeAmountPerReputation: number; diff --git a/markdown/bitburner.corpconstants.bribethreshold.md b/markdown/bitburner.corpconstants.bribethreshold.md index 501ea2e61..2bc11d735 100644 --- a/markdown/bitburner.corpconstants.bribethreshold.md +++ b/markdown/bitburner.corpconstants.bribethreshold.md @@ -4,7 +4,7 @@ ## CorpConstants.bribeThreshold property -Signature: +**Signature:** ```typescript bribeThreshold: number; diff --git a/markdown/bitburner.corpconstants.coffeecostperemployee.md b/markdown/bitburner.corpconstants.coffeecostperemployee.md index 827e55be0..162421b07 100644 --- a/markdown/bitburner.corpconstants.coffeecostperemployee.md +++ b/markdown/bitburner.corpconstants.coffeecostperemployee.md @@ -4,7 +4,7 @@ ## CorpConstants.coffeeCostPerEmployee property -Signature: +**Signature:** ```typescript coffeeCostPerEmployee: number; diff --git a/markdown/bitburner.corpconstants.dividendmaxrate.md b/markdown/bitburner.corpconstants.dividendmaxrate.md index 56b36b831..44afa97e6 100644 --- a/markdown/bitburner.corpconstants.dividendmaxrate.md +++ b/markdown/bitburner.corpconstants.dividendmaxrate.md @@ -4,7 +4,7 @@ ## CorpConstants.dividendMaxRate property -Signature: +**Signature:** ```typescript dividendMaxRate: number; diff --git a/markdown/bitburner.corpconstants.employeeraiseamount.md b/markdown/bitburner.corpconstants.employeeraiseamount.md index 5f616749c..74abf090e 100644 --- a/markdown/bitburner.corpconstants.employeeraiseamount.md +++ b/markdown/bitburner.corpconstants.employeeraiseamount.md @@ -4,7 +4,7 @@ ## CorpConstants.employeeRaiseAmount property -Signature: +**Signature:** ```typescript employeeRaiseAmount: number; diff --git a/markdown/bitburner.corpconstants.employeesalarymultiplier.md b/markdown/bitburner.corpconstants.employeesalarymultiplier.md index b5fee3fb3..a20e9ee38 100644 --- a/markdown/bitburner.corpconstants.employeesalarymultiplier.md +++ b/markdown/bitburner.corpconstants.employeesalarymultiplier.md @@ -6,7 +6,7 @@ Conversion factor for employee stats to initial salary -Signature: +**Signature:** ```typescript employeeSalaryMultiplier: number; diff --git a/markdown/bitburner.corpconstants.gamecyclespercorpstatecycle.md b/markdown/bitburner.corpconstants.gamecyclespercorpstatecycle.md index 3087ba944..c1eeec278 100644 --- a/markdown/bitburner.corpconstants.gamecyclespercorpstatecycle.md +++ b/markdown/bitburner.corpconstants.gamecyclespercorpstatecycle.md @@ -4,7 +4,7 @@ ## CorpConstants.gameCyclesPerCorpStateCycle property -Signature: +**Signature:** ```typescript gameCyclesPerCorpStateCycle: number; diff --git a/markdown/bitburner.corpconstants.gamecyclespermarketcycle.md b/markdown/bitburner.corpconstants.gamecyclespermarketcycle.md index b4c0861c7..c7d051b46 100644 --- a/markdown/bitburner.corpconstants.gamecyclespermarketcycle.md +++ b/markdown/bitburner.corpconstants.gamecyclespermarketcycle.md @@ -4,7 +4,7 @@ ## CorpConstants.gameCyclesPerMarketCycle property -Signature: +**Signature:** ```typescript gameCyclesPerMarketCycle: number; diff --git a/markdown/bitburner.corpconstants.industrynames.md b/markdown/bitburner.corpconstants.industrynames.md index 22056a0b5..c366b2d37 100644 --- a/markdown/bitburner.corpconstants.industrynames.md +++ b/markdown/bitburner.corpconstants.industrynames.md @@ -6,7 +6,7 @@ Names of all industries -Signature: +**Signature:** ```typescript industryNames: CorpIndustryName[]; diff --git a/markdown/bitburner.corpconstants.initialshares.md b/markdown/bitburner.corpconstants.initialshares.md index 3b3d9cc60..12f0168aa 100644 --- a/markdown/bitburner.corpconstants.initialshares.md +++ b/markdown/bitburner.corpconstants.initialshares.md @@ -4,7 +4,7 @@ ## CorpConstants.initialShares property -Signature: +**Signature:** ```typescript initialShares: number; diff --git a/markdown/bitburner.corpconstants.issuenewsharescooldown.md b/markdown/bitburner.corpconstants.issuenewsharescooldown.md index 317d399db..92ae766b7 100644 --- a/markdown/bitburner.corpconstants.issuenewsharescooldown.md +++ b/markdown/bitburner.corpconstants.issuenewsharescooldown.md @@ -6,7 +6,7 @@ Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) -Signature: +**Signature:** ```typescript issueNewSharesCooldown: number; diff --git a/markdown/bitburner.corpconstants.marketcyclesperemployeeraise.md b/markdown/bitburner.corpconstants.marketcyclesperemployeeraise.md index eff6cd23d..adaab89b3 100644 --- a/markdown/bitburner.corpconstants.marketcyclesperemployeeraise.md +++ b/markdown/bitburner.corpconstants.marketcyclesperemployeeraise.md @@ -4,7 +4,7 @@ ## CorpConstants.marketCyclesPerEmployeeRaise property -Signature: +**Signature:** ```typescript marketCyclesPerEmployeeRaise: number; diff --git a/markdown/bitburner.corpconstants.materialnames.md b/markdown/bitburner.corpconstants.materialnames.md index 97cd629ac..b3271182b 100644 --- a/markdown/bitburner.corpconstants.materialnames.md +++ b/markdown/bitburner.corpconstants.materialnames.md @@ -6,7 +6,7 @@ Names of all materials -Signature: +**Signature:** ```typescript materialNames: CorpMaterialName[]; diff --git a/markdown/bitburner.corpconstants.maxproductsbase.md b/markdown/bitburner.corpconstants.maxproductsbase.md index c2ac45f6e..572d82fa5 100644 --- a/markdown/bitburner.corpconstants.maxproductsbase.md +++ b/markdown/bitburner.corpconstants.maxproductsbase.md @@ -6,7 +6,7 @@ Max products for a division without upgrades -Signature: +**Signature:** ```typescript maxProductsBase: number; diff --git a/markdown/bitburner.corpconstants.md b/markdown/bitburner.corpconstants.md index 578040953..f1121b97e 100644 --- a/markdown/bitburner.corpconstants.md +++ b/markdown/bitburner.corpconstants.md @@ -6,7 +6,7 @@ Corporation related constants -Signature: +**Signature:** ```typescript interface CorpConstants @@ -14,37 +14,37 @@ interface CorpConstants ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md) | number | | -| [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | number | | -| [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | number | | -| [coffeeCostPerEmployee](./bitburner.corpconstants.coffeecostperemployee.md) | number | | -| [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | number | | -| [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | number | | -| [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | number | Conversion factor for employee stats to initial salary | -| [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | number | | -| [gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md) | number | | -| [industryNames](./bitburner.corpconstants.industrynames.md) | [CorpIndustryName](./bitburner.corpindustryname.md)\[\] | Names of all industries | -| [initialShares](./bitburner.corpconstants.initialshares.md) | number | | -| [issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md) | number | Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) | -| [marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md) | number | | -| [materialNames](./bitburner.corpconstants.materialnames.md) | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | Names of all materials | -| [maxProductsBase](./bitburner.corpconstants.maxproductsbase.md) | number | Max products for a division without upgrades | -| [minEmployeeDecay](./bitburner.corpconstants.minemployeedecay.md) | number | The minimum decay value for happiness/morale/energy | -| [officeInitialCost](./bitburner.corpconstants.officeinitialcost.md) | number | | -| [officeInitialSize](./bitburner.corpconstants.officeinitialsize.md) | number | | -| [officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md) | number | | -| [researchNames](./bitburner.corpconstants.researchnames.md) | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches | -| [researchNamesBase](./bitburner.corpconstants.researchnamesbase.md) | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches common to all industries | -| [researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md) | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches only available to product industries | -| [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | number | | -| [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) | -| [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | number | When selling large number of shares, price is dynamically updated for every batch of this amount | -| [stateNames](./bitburner.corpconstants.statenames.md) | [CorpStateName](./bitburner.corpstatename.md)\[\] | Names of all corporation game states | -| [unlockNames](./bitburner.corpconstants.unlocknames.md) | [CorpUnlockName](./bitburner.corpunlockname.md)\[\] | Names of all one-time corporation-wide unlocks | -| [upgradeNames](./bitburner.corpconstants.upgradenames.md) | [CorpUpgradeName](./bitburner.corpupgradename.md)\[\] | Names of all corporation-wide upgrades | -| [warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md) | number | | -| [warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md) | number | | -| [warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md) | | number | | +| [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | | number | | +| [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | | number | | +| [coffeeCostPerEmployee](./bitburner.corpconstants.coffeecostperemployee.md) | | number | | +| [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | | number | | +| [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | | number | | +| [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | | number | Conversion factor for employee stats to initial salary | +| [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | | number | | +| [gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md) | | number | | +| [industryNames](./bitburner.corpconstants.industrynames.md) | | [CorpIndustryName](./bitburner.corpindustryname.md)\[\] | Names of all industries | +| [initialShares](./bitburner.corpconstants.initialshares.md) | | number | | +| [issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md) | | number | Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) | +| [marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md) | | number | | +| [materialNames](./bitburner.corpconstants.materialnames.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | Names of all materials | +| [maxProductsBase](./bitburner.corpconstants.maxproductsbase.md) | | number | Max products for a division without upgrades | +| [minEmployeeDecay](./bitburner.corpconstants.minemployeedecay.md) | | number | The minimum decay value for happiness/morale/energy | +| [officeInitialCost](./bitburner.corpconstants.officeinitialcost.md) | | number | | +| [officeInitialSize](./bitburner.corpconstants.officeinitialsize.md) | | number | | +| [officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md) | | number | | +| [researchNames](./bitburner.corpconstants.researchnames.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches | +| [researchNamesBase](./bitburner.corpconstants.researchnamesbase.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches common to all industries | +| [researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches only available to product industries | +| [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | | number | | +| [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) | +| [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | | number | When selling large number of shares, price is dynamically updated for every batch of this amount | +| [stateNames](./bitburner.corpconstants.statenames.md) | | [CorpStateName](./bitburner.corpstatename.md)\[\] | Names of all corporation game states | +| [unlockNames](./bitburner.corpconstants.unlocknames.md) | | [CorpUnlockName](./bitburner.corpunlockname.md)\[\] | Names of all one-time corporation-wide unlocks | +| [upgradeNames](./bitburner.corpconstants.upgradenames.md) | | [CorpUpgradeName](./bitburner.corpupgradename.md)\[\] | Names of all corporation-wide upgrades | +| [warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md) | | number | | +| [warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md) | | number | | +| [warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md) | | number | | diff --git a/markdown/bitburner.corpconstants.minemployeedecay.md b/markdown/bitburner.corpconstants.minemployeedecay.md index 933af8d03..d596c0556 100644 --- a/markdown/bitburner.corpconstants.minemployeedecay.md +++ b/markdown/bitburner.corpconstants.minemployeedecay.md @@ -6,7 +6,7 @@ The minimum decay value for happiness/morale/energy -Signature: +**Signature:** ```typescript minEmployeeDecay: number; diff --git a/markdown/bitburner.corpconstants.officeinitialcost.md b/markdown/bitburner.corpconstants.officeinitialcost.md index b4a79f434..36a7e1b5d 100644 --- a/markdown/bitburner.corpconstants.officeinitialcost.md +++ b/markdown/bitburner.corpconstants.officeinitialcost.md @@ -4,7 +4,7 @@ ## CorpConstants.officeInitialCost property -Signature: +**Signature:** ```typescript officeInitialCost: number; diff --git a/markdown/bitburner.corpconstants.officeinitialsize.md b/markdown/bitburner.corpconstants.officeinitialsize.md index 38b7e35c3..dd0624b62 100644 --- a/markdown/bitburner.corpconstants.officeinitialsize.md +++ b/markdown/bitburner.corpconstants.officeinitialsize.md @@ -4,7 +4,7 @@ ## CorpConstants.officeInitialSize property -Signature: +**Signature:** ```typescript officeInitialSize: number; diff --git a/markdown/bitburner.corpconstants.officesizeupgradecostbase.md b/markdown/bitburner.corpconstants.officesizeupgradecostbase.md index 06e16f74f..0dc221636 100644 --- a/markdown/bitburner.corpconstants.officesizeupgradecostbase.md +++ b/markdown/bitburner.corpconstants.officesizeupgradecostbase.md @@ -4,7 +4,7 @@ ## CorpConstants.officeSizeUpgradeCostBase property -Signature: +**Signature:** ```typescript officeSizeUpgradeCostBase: number; diff --git a/markdown/bitburner.corpconstants.researchnames.md b/markdown/bitburner.corpconstants.researchnames.md index f53bf0bbd..cc95afdb5 100644 --- a/markdown/bitburner.corpconstants.researchnames.md +++ b/markdown/bitburner.corpconstants.researchnames.md @@ -6,7 +6,7 @@ Names of all researches -Signature: +**Signature:** ```typescript researchNames: CorpResearchName[]; diff --git a/markdown/bitburner.corpconstants.researchnamesbase.md b/markdown/bitburner.corpconstants.researchnamesbase.md index 63cff1190..19a88ca53 100644 --- a/markdown/bitburner.corpconstants.researchnamesbase.md +++ b/markdown/bitburner.corpconstants.researchnamesbase.md @@ -6,7 +6,7 @@ Names of all researches common to all industries -Signature: +**Signature:** ```typescript researchNamesBase: CorpResearchName[]; diff --git a/markdown/bitburner.corpconstants.researchnamesproductonly.md b/markdown/bitburner.corpconstants.researchnamesproductonly.md index 735dd7a53..eb50cb843 100644 --- a/markdown/bitburner.corpconstants.researchnamesproductonly.md +++ b/markdown/bitburner.corpconstants.researchnamesproductonly.md @@ -6,7 +6,7 @@ Names of all researches only available to product industries -Signature: +**Signature:** ```typescript researchNamesProductOnly: CorpResearchName[]; diff --git a/markdown/bitburner.corpconstants.secondspermarketcycle.md b/markdown/bitburner.corpconstants.secondspermarketcycle.md index 5723094c1..924fdc0db 100644 --- a/markdown/bitburner.corpconstants.secondspermarketcycle.md +++ b/markdown/bitburner.corpconstants.secondspermarketcycle.md @@ -4,7 +4,7 @@ ## CorpConstants.secondsPerMarketCycle property -Signature: +**Signature:** ```typescript secondsPerMarketCycle: number; diff --git a/markdown/bitburner.corpconstants.sellsharescooldown.md b/markdown/bitburner.corpconstants.sellsharescooldown.md index 89f78b2e9..f39512f44 100644 --- a/markdown/bitburner.corpconstants.sellsharescooldown.md +++ b/markdown/bitburner.corpconstants.sellsharescooldown.md @@ -6,7 +6,7 @@ Cooldown for selling shares in game cycles (1 game cycle = 200ms) -Signature: +**Signature:** ```typescript sellSharesCooldown: number; diff --git a/markdown/bitburner.corpconstants.sharesperpriceupdate.md b/markdown/bitburner.corpconstants.sharesperpriceupdate.md index 5244c1673..a2a69aec8 100644 --- a/markdown/bitburner.corpconstants.sharesperpriceupdate.md +++ b/markdown/bitburner.corpconstants.sharesperpriceupdate.md @@ -6,7 +6,7 @@ When selling large number of shares, price is dynamically updated for every batch of this amount -Signature: +**Signature:** ```typescript sharesPerPriceUpdate: number; diff --git a/markdown/bitburner.corpconstants.statenames.md b/markdown/bitburner.corpconstants.statenames.md index cd03a41e5..f21345cdf 100644 --- a/markdown/bitburner.corpconstants.statenames.md +++ b/markdown/bitburner.corpconstants.statenames.md @@ -6,7 +6,7 @@ Names of all corporation game states -Signature: +**Signature:** ```typescript stateNames: CorpStateName[]; diff --git a/markdown/bitburner.corpconstants.unlocknames.md b/markdown/bitburner.corpconstants.unlocknames.md index 69524785d..39e5b1015 100644 --- a/markdown/bitburner.corpconstants.unlocknames.md +++ b/markdown/bitburner.corpconstants.unlocknames.md @@ -6,7 +6,7 @@ Names of all one-time corporation-wide unlocks -Signature: +**Signature:** ```typescript unlockNames: CorpUnlockName[]; diff --git a/markdown/bitburner.corpconstants.upgradenames.md b/markdown/bitburner.corpconstants.upgradenames.md index 66e64b615..d6e07a7ec 100644 --- a/markdown/bitburner.corpconstants.upgradenames.md +++ b/markdown/bitburner.corpconstants.upgradenames.md @@ -6,7 +6,7 @@ Names of all corporation-wide upgrades -Signature: +**Signature:** ```typescript upgradeNames: CorpUpgradeName[]; diff --git a/markdown/bitburner.corpconstants.warehouseinitialcost.md b/markdown/bitburner.corpconstants.warehouseinitialcost.md index 52affbee6..03f9b7b58 100644 --- a/markdown/bitburner.corpconstants.warehouseinitialcost.md +++ b/markdown/bitburner.corpconstants.warehouseinitialcost.md @@ -4,7 +4,7 @@ ## CorpConstants.warehouseInitialCost property -Signature: +**Signature:** ```typescript warehouseInitialCost: number; diff --git a/markdown/bitburner.corpconstants.warehouseinitialsize.md b/markdown/bitburner.corpconstants.warehouseinitialsize.md index 6fddcae5c..0640ab539 100644 --- a/markdown/bitburner.corpconstants.warehouseinitialsize.md +++ b/markdown/bitburner.corpconstants.warehouseinitialsize.md @@ -4,7 +4,7 @@ ## CorpConstants.warehouseInitialSize property -Signature: +**Signature:** ```typescript warehouseInitialSize: number; diff --git a/markdown/bitburner.corpconstants.warehousesizeupgradecostbase.md b/markdown/bitburner.corpconstants.warehousesizeupgradecostbase.md index a5a7ae8a4..c2e01d3bc 100644 --- a/markdown/bitburner.corpconstants.warehousesizeupgradecostbase.md +++ b/markdown/bitburner.corpconstants.warehousesizeupgradecostbase.md @@ -4,7 +4,7 @@ ## CorpConstants.warehouseSizeUpgradeCostBase property -Signature: +**Signature:** ```typescript warehouseSizeUpgradeCostBase: number; diff --git a/markdown/bitburner.corpemployeeposition.md b/markdown/bitburner.corpemployeeposition.md index 5d3cf1484..07de11b22 100644 --- a/markdown/bitburner.corpemployeeposition.md +++ b/markdown/bitburner.corpemployeeposition.md @@ -5,7 +5,7 @@ ## CorpEmployeePosition type -Signature: +**Signature:** ```typescript type CorpEmployeePosition = diff --git a/markdown/bitburner.corpindustrydata.advertisingfactor.md b/markdown/bitburner.corpindustrydata.advertisingfactor.md index 0a6ee2731..ba9b42952 100644 --- a/markdown/bitburner.corpindustrydata.advertisingfactor.md +++ b/markdown/bitburner.corpindustrydata.advertisingfactor.md @@ -6,7 +6,7 @@ Advertising factor (affects sales) -Signature: +**Signature:** ```typescript advertisingFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.aicorefactor.md b/markdown/bitburner.corpindustrydata.aicorefactor.md index f2b597c3e..8a602fd19 100644 --- a/markdown/bitburner.corpindustrydata.aicorefactor.md +++ b/markdown/bitburner.corpindustrydata.aicorefactor.md @@ -6,7 +6,7 @@ AI Cores factor -Signature: +**Signature:** ```typescript aiCoreFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.description.md b/markdown/bitburner.corpindustrydata.description.md index 9e95550c7..0c6f90252 100644 --- a/markdown/bitburner.corpindustrydata.description.md +++ b/markdown/bitburner.corpindustrydata.description.md @@ -4,7 +4,7 @@ ## CorpIndustryData.description property -Signature: +**Signature:** ```typescript description: string; diff --git a/markdown/bitburner.corpindustrydata.hardwarefactor.md b/markdown/bitburner.corpindustrydata.hardwarefactor.md index 3024f2640..c93bd54ad 100644 --- a/markdown/bitburner.corpindustrydata.hardwarefactor.md +++ b/markdown/bitburner.corpindustrydata.hardwarefactor.md @@ -6,7 +6,7 @@ Hardware factor -Signature: +**Signature:** ```typescript hardwareFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.md b/markdown/bitburner.corpindustrydata.md index 829f9a717..beb0774c2 100644 --- a/markdown/bitburner.corpindustrydata.md +++ b/markdown/bitburner.corpindustrydata.md @@ -6,7 +6,7 @@ Data for an individual industry -Signature: +**Signature:** ```typescript interface CorpIndustryData @@ -14,18 +14,18 @@ interface CorpIndustryData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [advertisingFactor?](./bitburner.corpindustrydata.advertisingfactor.md) | number | (Optional) Advertising factor (affects sales) | -| [aiCoreFactor?](./bitburner.corpindustrydata.aicorefactor.md) | number | (Optional) AI Cores factor | -| [description](./bitburner.corpindustrydata.description.md) | string | | -| [hardwareFactor?](./bitburner.corpindustrydata.hardwarefactor.md) | number | (Optional) Hardware factor | -| [producedMaterials?](./bitburner.corpindustrydata.producedmaterials.md) | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | (Optional) | -| [product?](./bitburner.corpindustrydata.product.md) | [CorpProductData](./bitburner.corpproductdata.md) | (Optional) | -| [realEstateFactor?](./bitburner.corpindustrydata.realestatefactor.md) | number | (Optional) Real estate factor | -| [recommendStarting](./bitburner.corpindustrydata.recommendstarting.md) | boolean | | -| [requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md) | Partial<Record<[CorpMaterialName](./bitburner.corpmaterialname.md), number>> | | -| [robotFactor?](./bitburner.corpindustrydata.robotfactor.md) | number | (Optional) Robots factor | -| [scienceFactor?](./bitburner.corpindustrydata.sciencefactor.md) | number | (Optional) Scientific research factor (affects quality) | -| [startingCost](./bitburner.corpindustrydata.startingcost.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [advertisingFactor?](./bitburner.corpindustrydata.advertisingfactor.md) | | number | _(Optional)_ Advertising factor (affects sales) | +| [aiCoreFactor?](./bitburner.corpindustrydata.aicorefactor.md) | | number | _(Optional)_ AI Cores factor | +| [description](./bitburner.corpindustrydata.description.md) | | string | | +| [hardwareFactor?](./bitburner.corpindustrydata.hardwarefactor.md) | | number | _(Optional)_ Hardware factor | +| [producedMaterials?](./bitburner.corpindustrydata.producedmaterials.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | _(Optional)_ | +| [product?](./bitburner.corpindustrydata.product.md) | | [CorpProductData](./bitburner.corpproductdata.md) | _(Optional)_ | +| [realEstateFactor?](./bitburner.corpindustrydata.realestatefactor.md) | | number | _(Optional)_ Real estate factor | +| [recommendStarting](./bitburner.corpindustrydata.recommendstarting.md) | | boolean | | +| [requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md) | | Partial<Record<[CorpMaterialName](./bitburner.corpmaterialname.md), number>> | | +| [robotFactor?](./bitburner.corpindustrydata.robotfactor.md) | | number | _(Optional)_ Robots factor | +| [scienceFactor?](./bitburner.corpindustrydata.sciencefactor.md) | | number | _(Optional)_ Scientific research factor (affects quality) | +| [startingCost](./bitburner.corpindustrydata.startingcost.md) | | number | | diff --git a/markdown/bitburner.corpindustrydata.producedmaterials.md b/markdown/bitburner.corpindustrydata.producedmaterials.md index 5ba737018..e70f92650 100644 --- a/markdown/bitburner.corpindustrydata.producedmaterials.md +++ b/markdown/bitburner.corpindustrydata.producedmaterials.md @@ -4,7 +4,7 @@ ## CorpIndustryData.producedMaterials property -Signature: +**Signature:** ```typescript producedMaterials?: CorpMaterialName[]; diff --git a/markdown/bitburner.corpindustrydata.product.md b/markdown/bitburner.corpindustrydata.product.md index b9c9e5d33..0cd5cac15 100644 --- a/markdown/bitburner.corpindustrydata.product.md +++ b/markdown/bitburner.corpindustrydata.product.md @@ -4,7 +4,7 @@ ## CorpIndustryData.product property -Signature: +**Signature:** ```typescript product?: CorpProductData; diff --git a/markdown/bitburner.corpindustrydata.realestatefactor.md b/markdown/bitburner.corpindustrydata.realestatefactor.md index 0df329432..d11f1c624 100644 --- a/markdown/bitburner.corpindustrydata.realestatefactor.md +++ b/markdown/bitburner.corpindustrydata.realestatefactor.md @@ -6,7 +6,7 @@ Real estate factor -Signature: +**Signature:** ```typescript realEstateFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.recommendstarting.md b/markdown/bitburner.corpindustrydata.recommendstarting.md index 22f28b3ab..110a86f7d 100644 --- a/markdown/bitburner.corpindustrydata.recommendstarting.md +++ b/markdown/bitburner.corpindustrydata.recommendstarting.md @@ -4,7 +4,7 @@ ## CorpIndustryData.recommendStarting property -Signature: +**Signature:** ```typescript recommendStarting: boolean; diff --git a/markdown/bitburner.corpindustrydata.requiredmaterials.md b/markdown/bitburner.corpindustrydata.requiredmaterials.md index 41bdbe37d..035053d18 100644 --- a/markdown/bitburner.corpindustrydata.requiredmaterials.md +++ b/markdown/bitburner.corpindustrydata.requiredmaterials.md @@ -4,7 +4,7 @@ ## CorpIndustryData.requiredMaterials property -Signature: +**Signature:** ```typescript requiredMaterials: Partial>; diff --git a/markdown/bitburner.corpindustrydata.robotfactor.md b/markdown/bitburner.corpindustrydata.robotfactor.md index 7a9e56f4b..b01e74e2a 100644 --- a/markdown/bitburner.corpindustrydata.robotfactor.md +++ b/markdown/bitburner.corpindustrydata.robotfactor.md @@ -6,7 +6,7 @@ Robots factor -Signature: +**Signature:** ```typescript robotFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.sciencefactor.md b/markdown/bitburner.corpindustrydata.sciencefactor.md index 7dd044532..d7b04fa6b 100644 --- a/markdown/bitburner.corpindustrydata.sciencefactor.md +++ b/markdown/bitburner.corpindustrydata.sciencefactor.md @@ -6,7 +6,7 @@ Scientific research factor (affects quality) -Signature: +**Signature:** ```typescript scienceFactor?: number; diff --git a/markdown/bitburner.corpindustrydata.startingcost.md b/markdown/bitburner.corpindustrydata.startingcost.md index fe5564c38..a4fb3a03b 100644 --- a/markdown/bitburner.corpindustrydata.startingcost.md +++ b/markdown/bitburner.corpindustrydata.startingcost.md @@ -4,7 +4,7 @@ ## CorpIndustryData.startingCost property -Signature: +**Signature:** ```typescript startingCost: number; diff --git a/markdown/bitburner.corpindustryname.md b/markdown/bitburner.corpindustryname.md index b86895628..034e68f8e 100644 --- a/markdown/bitburner.corpindustryname.md +++ b/markdown/bitburner.corpindustryname.md @@ -5,7 +5,7 @@ ## CorpIndustryName type -Signature: +**Signature:** ```typescript type CorpIndustryName = diff --git a/markdown/bitburner.corpmaterialconstantdata.basecost.md b/markdown/bitburner.corpmaterialconstantdata.basecost.md index 62d74fd6b..ece9d60de 100644 --- a/markdown/bitburner.corpmaterialconstantdata.basecost.md +++ b/markdown/bitburner.corpmaterialconstantdata.basecost.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.baseCost property -Signature: +**Signature:** ```typescript baseCost: number; diff --git a/markdown/bitburner.corpmaterialconstantdata.basemarkup.md b/markdown/bitburner.corpmaterialconstantdata.basemarkup.md index 0a85352e1..f10d591b9 100644 --- a/markdown/bitburner.corpmaterialconstantdata.basemarkup.md +++ b/markdown/bitburner.corpmaterialconstantdata.basemarkup.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.baseMarkup property -Signature: +**Signature:** ```typescript baseMarkup: number; diff --git a/markdown/bitburner.corpmaterialconstantdata.competitionbase.md b/markdown/bitburner.corpmaterialconstantdata.competitionbase.md index d86d4b036..c7a2d3fd8 100644 --- a/markdown/bitburner.corpmaterialconstantdata.competitionbase.md +++ b/markdown/bitburner.corpmaterialconstantdata.competitionbase.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.competitionBase property -Signature: +**Signature:** ```typescript competitionBase: number; diff --git a/markdown/bitburner.corpmaterialconstantdata.competitionrange.md b/markdown/bitburner.corpmaterialconstantdata.competitionrange.md index f687d19d1..3797449fe 100644 --- a/markdown/bitburner.corpmaterialconstantdata.competitionrange.md +++ b/markdown/bitburner.corpmaterialconstantdata.competitionrange.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.competitionRange property -Signature: +**Signature:** ```typescript competitionRange: [min: number, max: number]; diff --git a/markdown/bitburner.corpmaterialconstantdata.demandbase.md b/markdown/bitburner.corpmaterialconstantdata.demandbase.md index 16fc5a6b6..029b8dfdc 100644 --- a/markdown/bitburner.corpmaterialconstantdata.demandbase.md +++ b/markdown/bitburner.corpmaterialconstantdata.demandbase.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.demandBase property -Signature: +**Signature:** ```typescript demandBase: number; diff --git a/markdown/bitburner.corpmaterialconstantdata.demandrange.md b/markdown/bitburner.corpmaterialconstantdata.demandrange.md index 69fac8cd2..e6c1f5949 100644 --- a/markdown/bitburner.corpmaterialconstantdata.demandrange.md +++ b/markdown/bitburner.corpmaterialconstantdata.demandrange.md @@ -6,7 +6,7 @@ Min and max demand -Signature: +**Signature:** ```typescript demandRange: [min: number, max: number]; diff --git a/markdown/bitburner.corpmaterialconstantdata.maxvolatility.md b/markdown/bitburner.corpmaterialconstantdata.maxvolatility.md index fb8d15cba..fb02bbb9f 100644 --- a/markdown/bitburner.corpmaterialconstantdata.maxvolatility.md +++ b/markdown/bitburner.corpmaterialconstantdata.maxvolatility.md @@ -4,7 +4,7 @@ ## CorpMaterialConstantData.maxVolatility property -Signature: +**Signature:** ```typescript maxVolatility: number; diff --git a/markdown/bitburner.corpmaterialconstantdata.md b/markdown/bitburner.corpmaterialconstantdata.md index c92b95d89..a7e722621 100644 --- a/markdown/bitburner.corpmaterialconstantdata.md +++ b/markdown/bitburner.corpmaterialconstantdata.md @@ -6,7 +6,7 @@ Corporation material information -Signature: +**Signature:** ```typescript interface CorpMaterialConstantData @@ -14,15 +14,15 @@ interface CorpMaterialConstantData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [baseCost](./bitburner.corpmaterialconstantdata.basecost.md) | number | | -| [baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md) | number | | -| [competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md) | number | | -| [competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md) | \[min: number, max: number\] | | -| [demandBase](./bitburner.corpmaterialconstantdata.demandbase.md) | number | | -| [demandRange](./bitburner.corpmaterialconstantdata.demandrange.md) | \[min: number, max: number\] | Min and max demand | -| [maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md) | number | | -| [name](./bitburner.corpmaterialconstantdata.name.md) | string | Name of the material | -| [size](./bitburner.corpmaterialconstantdata.size.md) | number | Size of the material | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [baseCost](./bitburner.corpmaterialconstantdata.basecost.md) | | number | | +| [baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md) | | number | | +| [competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md) | | number | | +| [competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md) | | \[min: number, max: number\] | | +| [demandBase](./bitburner.corpmaterialconstantdata.demandbase.md) | | number | | +| [demandRange](./bitburner.corpmaterialconstantdata.demandrange.md) | | \[min: number, max: number\] | Min and max demand | +| [maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md) | | number | | +| [name](./bitburner.corpmaterialconstantdata.name.md) | | string | Name of the material | +| [size](./bitburner.corpmaterialconstantdata.size.md) | | number | Size of the material | diff --git a/markdown/bitburner.corpmaterialconstantdata.name.md b/markdown/bitburner.corpmaterialconstantdata.name.md index b3305b957..79734b902 100644 --- a/markdown/bitburner.corpmaterialconstantdata.name.md +++ b/markdown/bitburner.corpmaterialconstantdata.name.md @@ -6,7 +6,7 @@ Name of the material -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.corpmaterialconstantdata.size.md b/markdown/bitburner.corpmaterialconstantdata.size.md index a3a1190e6..7d6b61fd5 100644 --- a/markdown/bitburner.corpmaterialconstantdata.size.md +++ b/markdown/bitburner.corpmaterialconstantdata.size.md @@ -6,7 +6,7 @@ Size of the material -Signature: +**Signature:** ```typescript size: number; diff --git a/markdown/bitburner.corpmaterialname.md b/markdown/bitburner.corpmaterialname.md index ba5f19ebd..678cc8301 100644 --- a/markdown/bitburner.corpmaterialname.md +++ b/markdown/bitburner.corpmaterialname.md @@ -5,7 +5,7 @@ ## CorpMaterialName type -Signature: +**Signature:** ```typescript type CorpMaterialName = diff --git a/markdown/bitburner.corporation.acceptinvestmentoffer.md b/markdown/bitburner.corporation.acceptinvestmentoffer.md index 84ade55ce..113dd81ea 100644 --- a/markdown/bitburner.corporation.acceptinvestmentoffer.md +++ b/markdown/bitburner.corporation.acceptinvestmentoffer.md @@ -6,12 +6,12 @@ Accept investment based on you companies current valuation -Signature: +**Signature:** ```typescript acceptInvestmentOffer(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.bribe.md b/markdown/bitburner.corporation.bribe.md index 3cbb2ba10..e5dd26136 100644 --- a/markdown/bitburner.corporation.bribe.md +++ b/markdown/bitburner.corporation.bribe.md @@ -6,7 +6,7 @@ Bribe a faction -Signature: +**Signature:** ```typescript bribe(factionName: string, amountCash: number): boolean; @@ -19,7 +19,7 @@ bribe(factionName: string, amountCash: number): boolean; | factionName | string | Faction name | | amountCash | number | Amount of money to bribe | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.buybackshares.md b/markdown/bitburner.corporation.buybackshares.md index ccc0a787b..1cd48f59e 100644 --- a/markdown/bitburner.corporation.buybackshares.md +++ b/markdown/bitburner.corporation.buybackshares.md @@ -6,7 +6,7 @@ Buyback Shares -Signature: +**Signature:** ```typescript buyBackShares(amount: number): void; @@ -18,7 +18,7 @@ buyBackShares(amount: number): void; | --- | --- | --- | | amount | number | Amount of shares to buy back. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.createcorporation.md b/markdown/bitburner.corporation.createcorporation.md index 30de005fa..ed4ecb174 100644 --- a/markdown/bitburner.corporation.createcorporation.md +++ b/markdown/bitburner.corporation.createcorporation.md @@ -6,7 +6,7 @@ Create a Corporation -Signature: +**Signature:** ```typescript createCorporation(corporationName: string, selfFund: boolean): boolean; @@ -19,7 +19,7 @@ createCorporation(corporationName: string, selfFund: boolean): boolean; | corporationName | string | Name of the corporation | | selfFund | boolean | If you should self fund, defaults to true, false will only work on Bitnode 3 | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.expandcity.md b/markdown/bitburner.corporation.expandcity.md index 8fb8271a9..bc728e26d 100644 --- a/markdown/bitburner.corporation.expandcity.md +++ b/markdown/bitburner.corporation.expandcity.md @@ -6,7 +6,7 @@ Expand to a new city -Signature: +**Signature:** ```typescript expandCity(divisionName: string, city: CityName | `${CityName}`): void; @@ -19,7 +19,7 @@ expandCity(divisionName: string, city: CityName | `${CityName}`): void; | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.expandindustry.md b/markdown/bitburner.corporation.expandindustry.md index 1ea9b6d01..61969295e 100644 --- a/markdown/bitburner.corporation.expandindustry.md +++ b/markdown/bitburner.corporation.expandindustry.md @@ -6,7 +6,7 @@ Expand to a new industry -Signature: +**Signature:** ```typescript expandIndustry(industryType: CorpIndustryName, divisionName: string): void; @@ -19,7 +19,7 @@ expandIndustry(industryType: CorpIndustryName, divisionName: string): void; | industryType | [CorpIndustryName](./bitburner.corpindustryname.md) | Name of the industry | | divisionName | string | Name of the division | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.getbonustime.md b/markdown/bitburner.corporation.getbonustime.md index f848218a7..2bf3385e1 100644 --- a/markdown/bitburner.corporation.getbonustime.md +++ b/markdown/bitburner.corporation.getbonustime.md @@ -6,12 +6,12 @@ Get bonus time. “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. -Signature: +**Signature:** ```typescript getBonusTime(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.corporation.getconstants.md b/markdown/bitburner.corporation.getconstants.md index 80f1116fc..4c571737c 100644 --- a/markdown/bitburner.corporation.getconstants.md +++ b/markdown/bitburner.corporation.getconstants.md @@ -6,12 +6,12 @@ Get corporation related constants -Signature: +**Signature:** ```typescript getConstants(): CorpConstants; ``` -Returns: +**Returns:** [CorpConstants](./bitburner.corpconstants.md) diff --git a/markdown/bitburner.corporation.getcorporation.md b/markdown/bitburner.corporation.getcorporation.md index d175e0be5..aba545650 100644 --- a/markdown/bitburner.corporation.getcorporation.md +++ b/markdown/bitburner.corporation.getcorporation.md @@ -6,12 +6,12 @@ Get corporation data -Signature: +**Signature:** ```typescript getCorporation(): CorporationInfo; ``` -Returns: +**Returns:** [CorporationInfo](./bitburner.corporationinfo.md) diff --git a/markdown/bitburner.corporation.getdivision.md b/markdown/bitburner.corporation.getdivision.md index f8a89be20..40a891dff 100644 --- a/markdown/bitburner.corporation.getdivision.md +++ b/markdown/bitburner.corporation.getdivision.md @@ -6,7 +6,7 @@ Get division data -Signature: +**Signature:** ```typescript getDivision(divisionName: string): Division; @@ -18,7 +18,7 @@ getDivision(divisionName: string): Division; | --- | --- | --- | | divisionName | string | Name of the division | -Returns: +**Returns:** [Division](./bitburner.division.md) diff --git a/markdown/bitburner.corporation.getindustrydata.md b/markdown/bitburner.corporation.getindustrydata.md index 9bb137935..7e951fb37 100644 --- a/markdown/bitburner.corporation.getindustrydata.md +++ b/markdown/bitburner.corporation.getindustrydata.md @@ -6,7 +6,7 @@ Get constant industry definition data for a specific industry -Signature: +**Signature:** ```typescript getIndustryData(industryName: CorpIndustryName): CorpIndustryData; @@ -18,7 +18,7 @@ getIndustryData(industryName: CorpIndustryName): CorpIndustryData; | --- | --- | --- | | industryName | [CorpIndustryName](./bitburner.corpindustryname.md) | | -Returns: +**Returns:** [CorpIndustryData](./bitburner.corpindustrydata.md) diff --git a/markdown/bitburner.corporation.getinvestmentoffer.md b/markdown/bitburner.corporation.getinvestmentoffer.md index a1bce820e..d483edbdd 100644 --- a/markdown/bitburner.corporation.getinvestmentoffer.md +++ b/markdown/bitburner.corporation.getinvestmentoffer.md @@ -6,12 +6,12 @@ Get an offer for investment based on you companies current valuation -Signature: +**Signature:** ```typescript getInvestmentOffer(): InvestmentOffer; ``` -Returns: +**Returns:** [InvestmentOffer](./bitburner.investmentoffer.md) diff --git a/markdown/bitburner.corporation.getmaterialdata.md b/markdown/bitburner.corporation.getmaterialdata.md index 48ed6b5c9..d11ea1372 100644 --- a/markdown/bitburner.corporation.getmaterialdata.md +++ b/markdown/bitburner.corporation.getmaterialdata.md @@ -6,7 +6,7 @@ Get constant data for a specific material -Signature: +**Signature:** ```typescript getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData; @@ -18,7 +18,7 @@ getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData; | --- | --- | --- | | materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | | -Returns: +**Returns:** [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) diff --git a/markdown/bitburner.corporation.getunlockupgradecost.md b/markdown/bitburner.corporation.getunlockupgradecost.md index 328ba6239..4f838cf7f 100644 --- a/markdown/bitburner.corporation.getunlockupgradecost.md +++ b/markdown/bitburner.corporation.getunlockupgradecost.md @@ -6,7 +6,7 @@ Gets the cost to unlock a one time unlockable upgrade -Signature: +**Signature:** ```typescript getUnlockUpgradeCost(upgradeName: string): number; @@ -18,7 +18,7 @@ getUnlockUpgradeCost(upgradeName: string): number; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** number diff --git a/markdown/bitburner.corporation.getupgradelevel.md b/markdown/bitburner.corporation.getupgradelevel.md index e2e74b60a..ddc26969f 100644 --- a/markdown/bitburner.corporation.getupgradelevel.md +++ b/markdown/bitburner.corporation.getupgradelevel.md @@ -6,7 +6,7 @@ Get the level of a levelable upgrade -Signature: +**Signature:** ```typescript getUpgradeLevel(upgradeName: string): number; @@ -18,7 +18,7 @@ getUpgradeLevel(upgradeName: string): number; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** number diff --git a/markdown/bitburner.corporation.getupgradelevelcost.md b/markdown/bitburner.corporation.getupgradelevelcost.md index fb26cd29a..fda135c56 100644 --- a/markdown/bitburner.corporation.getupgradelevelcost.md +++ b/markdown/bitburner.corporation.getupgradelevelcost.md @@ -6,7 +6,7 @@ Gets the cost to unlock the next level of a levelable upgrade -Signature: +**Signature:** ```typescript getUpgradeLevelCost(upgradeName: string): number; @@ -18,7 +18,7 @@ getUpgradeLevelCost(upgradeName: string): number; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** number diff --git a/markdown/bitburner.corporation.gopublic.md b/markdown/bitburner.corporation.gopublic.md index e5f370e3b..44dae0129 100644 --- a/markdown/bitburner.corporation.gopublic.md +++ b/markdown/bitburner.corporation.gopublic.md @@ -6,7 +6,7 @@ Go public -Signature: +**Signature:** ```typescript goPublic(numShares: number): boolean; @@ -18,7 +18,7 @@ goPublic(numShares: number): boolean; | --- | --- | --- | | numShares | number | number of shares you would like to issue for your IPO | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.hascorporation.md b/markdown/bitburner.corporation.hascorporation.md index 1cfb2594b..2b938791b 100644 --- a/markdown/bitburner.corporation.hascorporation.md +++ b/markdown/bitburner.corporation.hascorporation.md @@ -6,12 +6,12 @@ Returns whether the player has a corporation. Does not require API access. -Signature: +**Signature:** ```typescript hasCorporation(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.hasunlockupgrade.md b/markdown/bitburner.corporation.hasunlockupgrade.md index 869a78456..b13eeb0b6 100644 --- a/markdown/bitburner.corporation.hasunlockupgrade.md +++ b/markdown/bitburner.corporation.hasunlockupgrade.md @@ -6,7 +6,7 @@ Check if you have a one time unlockable upgrade -Signature: +**Signature:** ```typescript hasUnlockUpgrade(upgradeName: string): boolean; @@ -18,7 +18,7 @@ hasUnlockUpgrade(upgradeName: string): boolean; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.corporation.issuedividends.md b/markdown/bitburner.corporation.issuedividends.md index ce4552387..08eb25130 100644 --- a/markdown/bitburner.corporation.issuedividends.md +++ b/markdown/bitburner.corporation.issuedividends.md @@ -6,7 +6,7 @@ Issue dividends -Signature: +**Signature:** ```typescript issueDividends(rate: number): void; @@ -18,7 +18,7 @@ issueDividends(rate: number): void; | --- | --- | --- | | rate | number | Fraction of profit to issue as dividends. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.issuenewshares.md b/markdown/bitburner.corporation.issuenewshares.md index 8ea8a102f..650667fc5 100644 --- a/markdown/bitburner.corporation.issuenewshares.md +++ b/markdown/bitburner.corporation.issuenewshares.md @@ -6,7 +6,7 @@ Issue new shares -Signature: +**Signature:** ```typescript issueNewShares(amount?: number): number; @@ -16,9 +16,9 @@ issueNewShares(amount?: number): number; | Parameter | Type | Description | | --- | --- | --- | -| amount | number | Number of new shares to issue, will be rounded to nearest 10m. Defaults to max amount. | +| amount | number | _(Optional)_ Number of new shares to issue, will be rounded to nearest 10m. Defaults to max amount. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.corporation.levelupgrade.md b/markdown/bitburner.corporation.levelupgrade.md index f42f9d89b..7f6d8dcae 100644 --- a/markdown/bitburner.corporation.levelupgrade.md +++ b/markdown/bitburner.corporation.levelupgrade.md @@ -6,7 +6,7 @@ Level an upgrade. -Signature: +**Signature:** ```typescript levelUpgrade(upgradeName: string): void; @@ -18,7 +18,7 @@ levelUpgrade(upgradeName: string): void; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.md b/markdown/bitburner.corporation.md index c99284271..5910d429a 100644 --- a/markdown/bitburner.corporation.md +++ b/markdown/bitburner.corporation.md @@ -6,12 +6,12 @@ Corporation API -Signature: +**Signature:** ```typescript export interface Corporation extends WarehouseAPI, OfficeAPI ``` -Extends: [WarehouseAPI](./bitburner.warehouseapi.md), [OfficeAPI](./bitburner.officeapi.md) +**Extends:** [WarehouseAPI](./bitburner.warehouseapi.md), [OfficeAPI](./bitburner.officeapi.md) ## Methods diff --git a/markdown/bitburner.corporation.sellshares.md b/markdown/bitburner.corporation.sellshares.md index 6ee2b480a..327af394d 100644 --- a/markdown/bitburner.corporation.sellshares.md +++ b/markdown/bitburner.corporation.sellshares.md @@ -6,7 +6,7 @@ Sell Shares -Signature: +**Signature:** ```typescript sellShares(amount: number): void; @@ -18,7 +18,7 @@ sellShares(amount: number): void; | --- | --- | --- | | amount | number | Amount of shares to sell. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporation.unlockupgrade.md b/markdown/bitburner.corporation.unlockupgrade.md index 581d1bfb2..74a2448e3 100644 --- a/markdown/bitburner.corporation.unlockupgrade.md +++ b/markdown/bitburner.corporation.unlockupgrade.md @@ -6,7 +6,7 @@ Unlock an upgrade -Signature: +**Signature:** ```typescript unlockUpgrade(upgradeName: string): void; @@ -18,7 +18,7 @@ unlockUpgrade(upgradeName: string): void; | --- | --- | --- | | upgradeName | string | Name of the upgrade | -Returns: +**Returns:** void diff --git a/markdown/bitburner.corporationinfo.dividendearnings.md b/markdown/bitburner.corporationinfo.dividendearnings.md index 83ae2d741..d5a59d09a 100644 --- a/markdown/bitburner.corporationinfo.dividendearnings.md +++ b/markdown/bitburner.corporationinfo.dividendearnings.md @@ -6,7 +6,7 @@ Your earnings as a shareholder per second this cycle -Signature: +**Signature:** ```typescript dividendEarnings: number; diff --git a/markdown/bitburner.corporationinfo.dividendrate.md b/markdown/bitburner.corporationinfo.dividendrate.md index f3aa95f42..d8aeeffc9 100644 --- a/markdown/bitburner.corporationinfo.dividendrate.md +++ b/markdown/bitburner.corporationinfo.dividendrate.md @@ -6,7 +6,7 @@ Fraction of profits issued as dividends -Signature: +**Signature:** ```typescript dividendRate: number; diff --git a/markdown/bitburner.corporationinfo.dividendtax.md b/markdown/bitburner.corporationinfo.dividendtax.md index 5627593a2..f6f0d9b21 100644 --- a/markdown/bitburner.corporationinfo.dividendtax.md +++ b/markdown/bitburner.corporationinfo.dividendtax.md @@ -6,7 +6,7 @@ Tax applied on your earnings as a shareholder -Signature: +**Signature:** ```typescript dividendTax: number; diff --git a/markdown/bitburner.corporationinfo.divisions.md b/markdown/bitburner.corporationinfo.divisions.md index 2b72b8685..f0fe68dd6 100644 --- a/markdown/bitburner.corporationinfo.divisions.md +++ b/markdown/bitburner.corporationinfo.divisions.md @@ -6,7 +6,7 @@ Array of all division names -Signature: +**Signature:** ```typescript divisions: string[]; diff --git a/markdown/bitburner.corporationinfo.expenses.md b/markdown/bitburner.corporationinfo.expenses.md index 85f7bb246..146d18b42 100644 --- a/markdown/bitburner.corporationinfo.expenses.md +++ b/markdown/bitburner.corporationinfo.expenses.md @@ -6,7 +6,7 @@ Expenses per second this cycle -Signature: +**Signature:** ```typescript expenses: number; diff --git a/markdown/bitburner.corporationinfo.funds.md b/markdown/bitburner.corporationinfo.funds.md index 9484ae098..41d449293 100644 --- a/markdown/bitburner.corporationinfo.funds.md +++ b/markdown/bitburner.corporationinfo.funds.md @@ -6,7 +6,7 @@ Funds available -Signature: +**Signature:** ```typescript funds: number; diff --git a/markdown/bitburner.corporationinfo.issuedshares.md b/markdown/bitburner.corporationinfo.issuedshares.md index 2ad061a78..673228d79 100644 --- a/markdown/bitburner.corporationinfo.issuedshares.md +++ b/markdown/bitburner.corporationinfo.issuedshares.md @@ -6,7 +6,7 @@ Amount of acquirable shares. -Signature: +**Signature:** ```typescript issuedShares: number; diff --git a/markdown/bitburner.corporationinfo.md b/markdown/bitburner.corporationinfo.md index 5921d4032..298282a8e 100644 --- a/markdown/bitburner.corporationinfo.md +++ b/markdown/bitburner.corporationinfo.md @@ -6,7 +6,7 @@ General info about a corporation -Signature: +**Signature:** ```typescript interface CorporationInfo @@ -14,21 +14,21 @@ interface CorporationInfo ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [dividendEarnings](./bitburner.corporationinfo.dividendearnings.md) | number | Your earnings as a shareholder per second this cycle | -| [dividendRate](./bitburner.corporationinfo.dividendrate.md) | number | Fraction of profits issued as dividends | -| [dividendTax](./bitburner.corporationinfo.dividendtax.md) | number | Tax applied on your earnings as a shareholder | -| [divisions](./bitburner.corporationinfo.divisions.md) | string\[\] | Array of all division names | -| [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle | -| [funds](./bitburner.corporationinfo.funds.md) | number | Funds available | -| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of acquirable shares. | -| [name](./bitburner.corporationinfo.name.md) | string | Name of the corporation | -| [numShares](./bitburner.corporationinfo.numshares.md) | number | Amount of share owned | -| [public](./bitburner.corporationinfo.public.md) | boolean | Indicating if the company is public | -| [revenue](./bitburner.corporationinfo.revenue.md) | number | Revenue per second this cycle | -| [sharePrice](./bitburner.corporationinfo.shareprice.md) | number | Price of the shares | -| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | number | Cooldown until shares can be sold again | -| [state](./bitburner.corporationinfo.state.md) | string | State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. | -| [totalShares](./bitburner.corporationinfo.totalshares.md) | number | Total number of shares issues by this corporation | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [dividendEarnings](./bitburner.corporationinfo.dividendearnings.md) | | number | Your earnings as a shareholder per second this cycle | +| [dividendRate](./bitburner.corporationinfo.dividendrate.md) | | number | Fraction of profits issued as dividends | +| [dividendTax](./bitburner.corporationinfo.dividendtax.md) | | number | Tax applied on your earnings as a shareholder | +| [divisions](./bitburner.corporationinfo.divisions.md) | | string\[\] | Array of all division names | +| [expenses](./bitburner.corporationinfo.expenses.md) | | number | Expenses per second this cycle | +| [funds](./bitburner.corporationinfo.funds.md) | | number | Funds available | +| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | | number | Amount of acquirable shares. | +| [name](./bitburner.corporationinfo.name.md) | | string | Name of the corporation | +| [numShares](./bitburner.corporationinfo.numshares.md) | | number | Amount of share owned | +| [public](./bitburner.corporationinfo.public.md) | | boolean | Indicating if the company is public | +| [revenue](./bitburner.corporationinfo.revenue.md) | | number | Revenue per second this cycle | +| [sharePrice](./bitburner.corporationinfo.shareprice.md) | | number | Price of the shares | +| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | | number | Cooldown until shares can be sold again | +| [state](./bitburner.corporationinfo.state.md) | | string | State of the corporation. Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE. | +| [totalShares](./bitburner.corporationinfo.totalshares.md) | | number | Total number of shares issues by this corporation | diff --git a/markdown/bitburner.corporationinfo.name.md b/markdown/bitburner.corporationinfo.name.md index 03d66d85c..116018118 100644 --- a/markdown/bitburner.corporationinfo.name.md +++ b/markdown/bitburner.corporationinfo.name.md @@ -6,7 +6,7 @@ Name of the corporation -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.corporationinfo.numshares.md b/markdown/bitburner.corporationinfo.numshares.md index 1d44dd998..d85f3fec2 100644 --- a/markdown/bitburner.corporationinfo.numshares.md +++ b/markdown/bitburner.corporationinfo.numshares.md @@ -6,7 +6,7 @@ Amount of share owned -Signature: +**Signature:** ```typescript numShares: number; diff --git a/markdown/bitburner.corporationinfo.public.md b/markdown/bitburner.corporationinfo.public.md index 91fe2bbd9..9081e4bf1 100644 --- a/markdown/bitburner.corporationinfo.public.md +++ b/markdown/bitburner.corporationinfo.public.md @@ -6,7 +6,7 @@ Indicating if the company is public -Signature: +**Signature:** ```typescript public: boolean; diff --git a/markdown/bitburner.corporationinfo.revenue.md b/markdown/bitburner.corporationinfo.revenue.md index 45c2cf8a0..f69a144c6 100644 --- a/markdown/bitburner.corporationinfo.revenue.md +++ b/markdown/bitburner.corporationinfo.revenue.md @@ -6,7 +6,7 @@ Revenue per second this cycle -Signature: +**Signature:** ```typescript revenue: number; diff --git a/markdown/bitburner.corporationinfo.shareprice.md b/markdown/bitburner.corporationinfo.shareprice.md index 406c5abd2..981a774e4 100644 --- a/markdown/bitburner.corporationinfo.shareprice.md +++ b/markdown/bitburner.corporationinfo.shareprice.md @@ -6,7 +6,7 @@ Price of the shares -Signature: +**Signature:** ```typescript sharePrice: number; diff --git a/markdown/bitburner.corporationinfo.sharesalecooldown.md b/markdown/bitburner.corporationinfo.sharesalecooldown.md index dfc4128e1..ee52b375d 100644 --- a/markdown/bitburner.corporationinfo.sharesalecooldown.md +++ b/markdown/bitburner.corporationinfo.sharesalecooldown.md @@ -6,7 +6,7 @@ Cooldown until shares can be sold again -Signature: +**Signature:** ```typescript shareSaleCooldown: number; diff --git a/markdown/bitburner.corporationinfo.state.md b/markdown/bitburner.corporationinfo.state.md index 8319c609d..e100ee5aa 100644 --- a/markdown/bitburner.corporationinfo.state.md +++ b/markdown/bitburner.corporationinfo.state.md @@ -4,9 +4,9 @@ ## CorporationInfo.state property -State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. +State of the corporation. Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE. -Signature: +**Signature:** ```typescript state: string; diff --git a/markdown/bitburner.corporationinfo.totalshares.md b/markdown/bitburner.corporationinfo.totalshares.md index 991235960..2a87395d3 100644 --- a/markdown/bitburner.corporationinfo.totalshares.md +++ b/markdown/bitburner.corporationinfo.totalshares.md @@ -6,7 +6,7 @@ Total number of shares issues by this corporation -Signature: +**Signature:** ```typescript totalShares: number; diff --git a/markdown/bitburner.corpproductdata.desc.md b/markdown/bitburner.corpproductdata.desc.md new file mode 100644 index 000000000..8bd3d33dd --- /dev/null +++ b/markdown/bitburner.corpproductdata.desc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpProductData](./bitburner.corpproductdata.md) > [desc](./bitburner.corpproductdata.desc.md) + +## CorpProductData.desc property + +Description of product creation + +**Signature:** + +```typescript +desc: string; +``` diff --git a/markdown/bitburner.corpproductdata.md b/markdown/bitburner.corpproductdata.md index 63dd1f473..b0969450d 100644 --- a/markdown/bitburner.corpproductdata.md +++ b/markdown/bitburner.corpproductdata.md @@ -2,24 +2,22 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CorpProductData](./bitburner.corpproductdata.md) -## CorpProductData type +## CorpProductData interface Product rating information -Signature: +**Signature:** ```typescript -type CorpProductData = { - name: string; - verb: string; - desc: string; - ratingWeights: { - aesthetics?: number; - durability?: number; - features?: number; - quality?: number; - performance?: number; - reliability?: number; - }; -}; +interface CorpProductData ``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [desc](./bitburner.corpproductdata.desc.md) | | string | Description of product creation | +| [name](./bitburner.corpproductdata.name.md) | | string | Name of the product | +| [ratingWeights](./bitburner.corpproductdata.ratingweights.md) | | { aesthetics?: number; durability?: number; features?: number; quality?: number; performance?: number; reliability?: number; } | Weighting factors for product | +| [verb](./bitburner.corpproductdata.verb.md) | | string | Verb used to describe creation of the product | + diff --git a/markdown/bitburner.corpproductdata.name.md b/markdown/bitburner.corpproductdata.name.md new file mode 100644 index 000000000..ef8ad7be1 --- /dev/null +++ b/markdown/bitburner.corpproductdata.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpProductData](./bitburner.corpproductdata.md) > [name](./bitburner.corpproductdata.name.md) + +## CorpProductData.name property + +Name of the product + +**Signature:** + +```typescript +name: string; +``` diff --git a/markdown/bitburner.corpproductdata.ratingweights.md b/markdown/bitburner.corpproductdata.ratingweights.md new file mode 100644 index 000000000..70ff55fe4 --- /dev/null +++ b/markdown/bitburner.corpproductdata.ratingweights.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpProductData](./bitburner.corpproductdata.md) > [ratingWeights](./bitburner.corpproductdata.ratingweights.md) + +## CorpProductData.ratingWeights property + +Weighting factors for product + +**Signature:** + +```typescript +ratingWeights: { + aesthetics?: number; + durability?: number; + features?: number; + quality?: number; + performance?: number; + reliability?: number; + }; +``` diff --git a/markdown/bitburner.corpproductdata.verb.md b/markdown/bitburner.corpproductdata.verb.md new file mode 100644 index 000000000..f5fef888b --- /dev/null +++ b/markdown/bitburner.corpproductdata.verb.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpProductData](./bitburner.corpproductdata.md) > [verb](./bitburner.corpproductdata.verb.md) + +## CorpProductData.verb property + +Verb used to describe creation of the product + +**Signature:** + +```typescript +verb: string; +``` diff --git a/markdown/bitburner.corpresearchname.md b/markdown/bitburner.corpresearchname.md index c506a8d1c..62bb801c7 100644 --- a/markdown/bitburner.corpresearchname.md +++ b/markdown/bitburner.corpresearchname.md @@ -5,7 +5,7 @@ ## CorpResearchName type -Signature: +**Signature:** ```typescript type CorpResearchName = diff --git a/markdown/bitburner.corpstatename.md b/markdown/bitburner.corpstatename.md index a9aa15716..fc6c83322 100644 --- a/markdown/bitburner.corpstatename.md +++ b/markdown/bitburner.corpstatename.md @@ -5,8 +5,8 @@ ## CorpStateName type -Signature: +**Signature:** ```typescript -type CorpStateName = "START" | "PURCHASE" | "PRODUCTION" | "SALE" | "EXPORT"; +type CorpStateName = "START" | "PURCHASE" | "PRODUCTION" | "EXPORT" | "SALE"; ``` diff --git a/markdown/bitburner.corpunlockname.md b/markdown/bitburner.corpunlockname.md index 0749cec81..4b30e4874 100644 --- a/markdown/bitburner.corpunlockname.md +++ b/markdown/bitburner.corpunlockname.md @@ -5,7 +5,7 @@ ## CorpUnlockName type -Signature: +**Signature:** ```typescript type CorpUnlockName = diff --git a/markdown/bitburner.corpupgradename.md b/markdown/bitburner.corpupgradename.md index 7a3f6b96f..8b755536f 100644 --- a/markdown/bitburner.corpupgradename.md +++ b/markdown/bitburner.corpupgradename.md @@ -5,7 +5,7 @@ ## CorpUpgradeName type -Signature: +**Signature:** ```typescript type CorpUpgradeName = diff --git a/markdown/bitburner.crimestats.agility_exp.md b/markdown/bitburner.crimestats.agility_exp.md index 0ed46e84f..c7cbd935b 100644 --- a/markdown/bitburner.crimestats.agility_exp.md +++ b/markdown/bitburner.crimestats.agility_exp.md @@ -6,7 +6,7 @@ agility exp gained from crime -Signature: +**Signature:** ```typescript agility_exp: number; diff --git a/markdown/bitburner.crimestats.agility_success_weight.md b/markdown/bitburner.crimestats.agility_success_weight.md index 6f803dd53..9a8a453e2 100644 --- a/markdown/bitburner.crimestats.agility_success_weight.md +++ b/markdown/bitburner.crimestats.agility_success_weight.md @@ -6,7 +6,7 @@ agility level impact on success change of the crime -Signature: +**Signature:** ```typescript agility_success_weight: number; diff --git a/markdown/bitburner.crimestats.charisma_exp.md b/markdown/bitburner.crimestats.charisma_exp.md index c4e10072c..21e0745ec 100644 --- a/markdown/bitburner.crimestats.charisma_exp.md +++ b/markdown/bitburner.crimestats.charisma_exp.md @@ -6,7 +6,7 @@ charisma exp gained from crime -Signature: +**Signature:** ```typescript charisma_exp: number; diff --git a/markdown/bitburner.crimestats.charisma_success_weight.md b/markdown/bitburner.crimestats.charisma_success_weight.md index 37e0d18d0..0ed44a7b1 100644 --- a/markdown/bitburner.crimestats.charisma_success_weight.md +++ b/markdown/bitburner.crimestats.charisma_success_weight.md @@ -6,7 +6,7 @@ charisma level impact on success change of the crime -Signature: +**Signature:** ```typescript charisma_success_weight: number; diff --git a/markdown/bitburner.crimestats.defense_exp.md b/markdown/bitburner.crimestats.defense_exp.md index e9f24d83c..ecb1dcfb6 100644 --- a/markdown/bitburner.crimestats.defense_exp.md +++ b/markdown/bitburner.crimestats.defense_exp.md @@ -6,7 +6,7 @@ defense exp gained from crime -Signature: +**Signature:** ```typescript defense_exp: number; diff --git a/markdown/bitburner.crimestats.defense_success_weight.md b/markdown/bitburner.crimestats.defense_success_weight.md index 1afef799a..29fe2aa9e 100644 --- a/markdown/bitburner.crimestats.defense_success_weight.md +++ b/markdown/bitburner.crimestats.defense_success_weight.md @@ -6,7 +6,7 @@ defense level impact on success change of the crime -Signature: +**Signature:** ```typescript defense_success_weight: number; diff --git a/markdown/bitburner.crimestats.dexterity_exp.md b/markdown/bitburner.crimestats.dexterity_exp.md index 960176994..9fa29268a 100644 --- a/markdown/bitburner.crimestats.dexterity_exp.md +++ b/markdown/bitburner.crimestats.dexterity_exp.md @@ -6,7 +6,7 @@ dexterity exp gained from crime -Signature: +**Signature:** ```typescript dexterity_exp: number; diff --git a/markdown/bitburner.crimestats.dexterity_success_weight.md b/markdown/bitburner.crimestats.dexterity_success_weight.md index 26b846f7a..8564c8df4 100644 --- a/markdown/bitburner.crimestats.dexterity_success_weight.md +++ b/markdown/bitburner.crimestats.dexterity_success_weight.md @@ -6,7 +6,7 @@ dexterity level impact on success change of the crime -Signature: +**Signature:** ```typescript dexterity_success_weight: number; diff --git a/markdown/bitburner.crimestats.difficulty.md b/markdown/bitburner.crimestats.difficulty.md index 36bfa92ea..80879dd90 100644 --- a/markdown/bitburner.crimestats.difficulty.md +++ b/markdown/bitburner.crimestats.difficulty.md @@ -6,7 +6,7 @@ Number representing the difficulty of the crime. Used for success chance calculations -Signature: +**Signature:** ```typescript difficulty: number; diff --git a/markdown/bitburner.crimestats.hacking_exp.md b/markdown/bitburner.crimestats.hacking_exp.md index 56a96c971..adbfdb6c7 100644 --- a/markdown/bitburner.crimestats.hacking_exp.md +++ b/markdown/bitburner.crimestats.hacking_exp.md @@ -6,7 +6,7 @@ hacking exp gained from crime -Signature: +**Signature:** ```typescript hacking_exp: number; diff --git a/markdown/bitburner.crimestats.hacking_success_weight.md b/markdown/bitburner.crimestats.hacking_success_weight.md index f57d9fbb8..3f8b173e4 100644 --- a/markdown/bitburner.crimestats.hacking_success_weight.md +++ b/markdown/bitburner.crimestats.hacking_success_weight.md @@ -6,7 +6,7 @@ hacking level impact on success change of the crime -Signature: +**Signature:** ```typescript hacking_success_weight: number; diff --git a/markdown/bitburner.crimestats.intelligence_exp.md b/markdown/bitburner.crimestats.intelligence_exp.md index b2fb67f2a..969dc3976 100644 --- a/markdown/bitburner.crimestats.intelligence_exp.md +++ b/markdown/bitburner.crimestats.intelligence_exp.md @@ -6,7 +6,7 @@ intelligence exp gained from crime -Signature: +**Signature:** ```typescript intelligence_exp: number; diff --git a/markdown/bitburner.crimestats.karma.md b/markdown/bitburner.crimestats.karma.md index fdcc4c7f6..30be44666 100644 --- a/markdown/bitburner.crimestats.karma.md +++ b/markdown/bitburner.crimestats.karma.md @@ -6,7 +6,7 @@ Amount of karma lost for successfully committing this crime -Signature: +**Signature:** ```typescript karma: number; diff --git a/markdown/bitburner.crimestats.kills.md b/markdown/bitburner.crimestats.kills.md index 963b8edc4..7d59bef84 100644 --- a/markdown/bitburner.crimestats.kills.md +++ b/markdown/bitburner.crimestats.kills.md @@ -6,7 +6,7 @@ How many people die as a result of this crime -Signature: +**Signature:** ```typescript kills: number; diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md index facf715f7..b32af9459 100644 --- a/markdown/bitburner.crimestats.md +++ b/markdown/bitburner.crimestats.md @@ -6,7 +6,7 @@ Data representing the internal values of a crime. -Signature: +**Signature:** ```typescript interface CrimeStats @@ -14,25 +14,25 @@ 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 | -| [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 | +| Property | Modifiers | 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 | +| [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 index 6260a2059..d36099383 100644 --- a/markdown/bitburner.crimestats.money.md +++ b/markdown/bitburner.crimestats.money.md @@ -6,7 +6,7 @@ How much money is given -Signature: +**Signature:** ```typescript money: number; diff --git a/markdown/bitburner.crimestats.strength_exp.md b/markdown/bitburner.crimestats.strength_exp.md index e30f029b7..b120b2ad2 100644 --- a/markdown/bitburner.crimestats.strength_exp.md +++ b/markdown/bitburner.crimestats.strength_exp.md @@ -6,7 +6,7 @@ strength exp gained from crime -Signature: +**Signature:** ```typescript strength_exp: number; diff --git a/markdown/bitburner.crimestats.strength_success_weight.md b/markdown/bitburner.crimestats.strength_success_weight.md index e8806edeb..5abc58ba3 100644 --- a/markdown/bitburner.crimestats.strength_success_weight.md +++ b/markdown/bitburner.crimestats.strength_success_weight.md @@ -6,7 +6,7 @@ strength level impact on success change of the crime -Signature: +**Signature:** ```typescript strength_success_weight: number; diff --git a/markdown/bitburner.crimestats.time.md b/markdown/bitburner.crimestats.time.md index 60218a10f..8b3103aa2 100644 --- a/markdown/bitburner.crimestats.time.md +++ b/markdown/bitburner.crimestats.time.md @@ -6,7 +6,7 @@ Milliseconds it takes to attempt the crime -Signature: +**Signature:** ```typescript time: number; diff --git a/markdown/bitburner.crimestats.type.md b/markdown/bitburner.crimestats.type.md index d6fba340b..c29eede63 100644 --- a/markdown/bitburner.crimestats.type.md +++ b/markdown/bitburner.crimestats.type.md @@ -6,7 +6,7 @@ Description of the crime activity -Signature: +**Signature:** ```typescript type: string; diff --git a/markdown/bitburner.crimetype.md b/markdown/bitburner.crimetype.md index bddd47bf7..ce311fc62 100644 --- a/markdown/bitburner.crimetype.md +++ b/markdown/bitburner.crimetype.md @@ -5,7 +5,7 @@ ## CrimeType enum -Signature: +**Signature:** ```typescript declare enum CrimeType diff --git a/markdown/bitburner.division.awareness.md b/markdown/bitburner.division.awareness.md index 73daec486..1111fe09c 100644 --- a/markdown/bitburner.division.awareness.md +++ b/markdown/bitburner.division.awareness.md @@ -6,7 +6,7 @@ Awareness of the division -Signature: +**Signature:** ```typescript awareness: number; diff --git a/markdown/bitburner.division.cities.md b/markdown/bitburner.division.cities.md index 921014f19..8bb984924 100644 --- a/markdown/bitburner.division.cities.md +++ b/markdown/bitburner.division.cities.md @@ -6,7 +6,7 @@ Cities in which this division has expanded -Signature: +**Signature:** ```typescript cities: CityName[]; diff --git a/markdown/bitburner.division.lastcycleexpenses.md b/markdown/bitburner.division.lastcycleexpenses.md index b29350d75..b86d97157 100644 --- a/markdown/bitburner.division.lastcycleexpenses.md +++ b/markdown/bitburner.division.lastcycleexpenses.md @@ -6,7 +6,7 @@ Expenses last cycle -Signature: +**Signature:** ```typescript lastCycleExpenses: number; diff --git a/markdown/bitburner.division.lastcyclerevenue.md b/markdown/bitburner.division.lastcyclerevenue.md index 9a26db7ab..64ce13bbe 100644 --- a/markdown/bitburner.division.lastcyclerevenue.md +++ b/markdown/bitburner.division.lastcyclerevenue.md @@ -6,7 +6,7 @@ Revenue last cycle -Signature: +**Signature:** ```typescript lastCycleRevenue: number; diff --git a/markdown/bitburner.division.makesproducts.md b/markdown/bitburner.division.makesproducts.md index f624b2267..de50f25be 100644 --- a/markdown/bitburner.division.makesproducts.md +++ b/markdown/bitburner.division.makesproducts.md @@ -6,7 +6,7 @@ Whether the industry this division is in is capable of making products -Signature: +**Signature:** ```typescript makesProducts: boolean; diff --git a/markdown/bitburner.division.md b/markdown/bitburner.division.md index 64a0b4de3..53ccc1796 100644 --- a/markdown/bitburner.division.md +++ b/markdown/bitburner.division.md @@ -6,7 +6,7 @@ Corporation division -Signature: +**Signature:** ```typescript interface Division @@ -14,20 +14,20 @@ interface Division ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [awareness](./bitburner.division.awareness.md) | number | Awareness of the division | -| [cities](./bitburner.division.cities.md) | [CityName](./bitburner.cityname.md)\[\] | Cities in which this division has expanded | -| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | number | Expenses last cycle | -| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | number | Revenue last cycle | -| [makesProducts](./bitburner.division.makesproducts.md) | boolean | Whether the industry this division is in is capable of making products | -| [name](./bitburner.division.name.md) | string | Name of the division | -| [popularity](./bitburner.division.popularity.md) | number | Popularity of the division | -| [prodMult](./bitburner.division.prodmult.md) | number | Production multiplier | -| [products](./bitburner.division.products.md) | string\[\] | Products developed by this division | -| [research](./bitburner.division.research.md) | number | Amount of research in that division | -| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | number | Expenses this cycle | -| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | number | Revenue this cycle | -| [type](./bitburner.division.type.md) | [CorpIndustryName](./bitburner.corpindustryname.md) | Type of division, like Agriculture | -| [upgrades](./bitburner.division.upgrades.md) | number\[\] | All research bought | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [awareness](./bitburner.division.awareness.md) | | number | Awareness of the division | +| [cities](./bitburner.division.cities.md) | | [CityName](./bitburner.cityname.md)\[\] | Cities in which this division has expanded | +| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | | number | Expenses last cycle | +| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | | number | Revenue last cycle | +| [makesProducts](./bitburner.division.makesproducts.md) | | boolean | Whether the industry this division is in is capable of making products | +| [name](./bitburner.division.name.md) | | string | Name of the division | +| [popularity](./bitburner.division.popularity.md) | | number | Popularity of the division | +| [prodMult](./bitburner.division.prodmult.md) | | number | Production multiplier | +| [products](./bitburner.division.products.md) | | string\[\] | Products developed by this division | +| [research](./bitburner.division.research.md) | | number | Amount of research in that division | +| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | | number | Expenses this cycle | +| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | | number | Revenue this cycle | +| [type](./bitburner.division.type.md) | | [CorpIndustryName](./bitburner.corpindustryname.md) | Type of division, like Agriculture | +| [upgrades](./bitburner.division.upgrades.md) | | number\[\] | All research bought | diff --git a/markdown/bitburner.division.name.md b/markdown/bitburner.division.name.md index 2896df398..2e908a962 100644 --- a/markdown/bitburner.division.name.md +++ b/markdown/bitburner.division.name.md @@ -6,7 +6,7 @@ Name of the division -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.division.popularity.md b/markdown/bitburner.division.popularity.md index 50bdb7986..9c247bb4a 100644 --- a/markdown/bitburner.division.popularity.md +++ b/markdown/bitburner.division.popularity.md @@ -6,7 +6,7 @@ Popularity of the division -Signature: +**Signature:** ```typescript popularity: number; diff --git a/markdown/bitburner.division.prodmult.md b/markdown/bitburner.division.prodmult.md index 13e563abf..23f284fe6 100644 --- a/markdown/bitburner.division.prodmult.md +++ b/markdown/bitburner.division.prodmult.md @@ -6,7 +6,7 @@ Production multiplier -Signature: +**Signature:** ```typescript prodMult: number; diff --git a/markdown/bitburner.division.products.md b/markdown/bitburner.division.products.md index 182c8e1f4..a8e1e9b4a 100644 --- a/markdown/bitburner.division.products.md +++ b/markdown/bitburner.division.products.md @@ -6,7 +6,7 @@ Products developed by this division -Signature: +**Signature:** ```typescript products: string[]; diff --git a/markdown/bitburner.division.research.md b/markdown/bitburner.division.research.md index 927f2c924..63012a4c0 100644 --- a/markdown/bitburner.division.research.md +++ b/markdown/bitburner.division.research.md @@ -6,7 +6,7 @@ Amount of research in that division -Signature: +**Signature:** ```typescript research: number; diff --git a/markdown/bitburner.division.thiscycleexpenses.md b/markdown/bitburner.division.thiscycleexpenses.md index b6db4ad28..89f818cdf 100644 --- a/markdown/bitburner.division.thiscycleexpenses.md +++ b/markdown/bitburner.division.thiscycleexpenses.md @@ -6,7 +6,7 @@ Expenses this cycle -Signature: +**Signature:** ```typescript thisCycleExpenses: number; diff --git a/markdown/bitburner.division.thiscyclerevenue.md b/markdown/bitburner.division.thiscyclerevenue.md index 1a66b28fc..4b9954581 100644 --- a/markdown/bitburner.division.thiscyclerevenue.md +++ b/markdown/bitburner.division.thiscyclerevenue.md @@ -6,7 +6,7 @@ Revenue this cycle -Signature: +**Signature:** ```typescript thisCycleRevenue: number; diff --git a/markdown/bitburner.division.type.md b/markdown/bitburner.division.type.md index 525d553b3..030e16fad 100644 --- a/markdown/bitburner.division.type.md +++ b/markdown/bitburner.division.type.md @@ -6,7 +6,7 @@ Type of division, like Agriculture -Signature: +**Signature:** ```typescript type: CorpIndustryName; diff --git a/markdown/bitburner.division.upgrades.md b/markdown/bitburner.division.upgrades.md index 616f2209f..7a823cc94 100644 --- a/markdown/bitburner.division.upgrades.md +++ b/markdown/bitburner.division.upgrades.md @@ -6,7 +6,7 @@ All research bought -Signature: +**Signature:** ```typescript upgrades: number[]; diff --git a/markdown/bitburner.equipmentstats.agi.md b/markdown/bitburner.equipmentstats.agi.md index c300582de..dcf08bb9f 100644 --- a/markdown/bitburner.equipmentstats.agi.md +++ b/markdown/bitburner.equipmentstats.agi.md @@ -6,7 +6,7 @@ Agility multiplier -Signature: +**Signature:** ```typescript agi?: number; diff --git a/markdown/bitburner.equipmentstats.cha.md b/markdown/bitburner.equipmentstats.cha.md index b31da6453..ef61db57e 100644 --- a/markdown/bitburner.equipmentstats.cha.md +++ b/markdown/bitburner.equipmentstats.cha.md @@ -6,7 +6,7 @@ Charisma multiplier -Signature: +**Signature:** ```typescript cha?: number; diff --git a/markdown/bitburner.equipmentstats.def.md b/markdown/bitburner.equipmentstats.def.md index 369dc7de2..7b91493b8 100644 --- a/markdown/bitburner.equipmentstats.def.md +++ b/markdown/bitburner.equipmentstats.def.md @@ -6,7 +6,7 @@ Defense multiplier -Signature: +**Signature:** ```typescript def?: number; diff --git a/markdown/bitburner.equipmentstats.dex.md b/markdown/bitburner.equipmentstats.dex.md index feadd6180..b61f78cbf 100644 --- a/markdown/bitburner.equipmentstats.dex.md +++ b/markdown/bitburner.equipmentstats.dex.md @@ -6,7 +6,7 @@ Dexterity multiplier -Signature: +**Signature:** ```typescript dex?: number; diff --git a/markdown/bitburner.equipmentstats.hack.md b/markdown/bitburner.equipmentstats.hack.md index 96609431e..d2274c78e 100644 --- a/markdown/bitburner.equipmentstats.hack.md +++ b/markdown/bitburner.equipmentstats.hack.md @@ -6,7 +6,7 @@ Hacking multiplier -Signature: +**Signature:** ```typescript hack?: number; diff --git a/markdown/bitburner.equipmentstats.md b/markdown/bitburner.equipmentstats.md index 4c0e9d37c..8fda26d3f 100644 --- a/markdown/bitburner.equipmentstats.md +++ b/markdown/bitburner.equipmentstats.md @@ -6,7 +6,7 @@ Object representing data representing a gang member equipment. -Signature: +**Signature:** ```typescript interface EquipmentStats @@ -14,12 +14,12 @@ interface EquipmentStats ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agi?](./bitburner.equipmentstats.agi.md) | number | (Optional) Agility multiplier | -| [cha?](./bitburner.equipmentstats.cha.md) | number | (Optional) Charisma multiplier | -| [def?](./bitburner.equipmentstats.def.md) | number | (Optional) Defense multiplier | -| [dex?](./bitburner.equipmentstats.dex.md) | number | (Optional) Dexterity multiplier | -| [hack?](./bitburner.equipmentstats.hack.md) | number | (Optional) Hacking multiplier | -| [str?](./bitburner.equipmentstats.str.md) | number | (Optional) Strength multiplier | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agi?](./bitburner.equipmentstats.agi.md) | | number | _(Optional)_ Agility multiplier | +| [cha?](./bitburner.equipmentstats.cha.md) | | number | _(Optional)_ Charisma multiplier | +| [def?](./bitburner.equipmentstats.def.md) | | number | _(Optional)_ Defense multiplier | +| [dex?](./bitburner.equipmentstats.dex.md) | | number | _(Optional)_ Dexterity multiplier | +| [hack?](./bitburner.equipmentstats.hack.md) | | number | _(Optional)_ Hacking multiplier | +| [str?](./bitburner.equipmentstats.str.md) | | number | _(Optional)_ Strength multiplier | diff --git a/markdown/bitburner.equipmentstats.str.md b/markdown/bitburner.equipmentstats.str.md index 6a9bc64ca..967a2a1c8 100644 --- a/markdown/bitburner.equipmentstats.str.md +++ b/markdown/bitburner.equipmentstats.str.md @@ -6,7 +6,7 @@ Strength multiplier -Signature: +**Signature:** ```typescript str?: number; diff --git a/markdown/bitburner.export.amt.md b/markdown/bitburner.export.amt.md index 670b14ca5..6eef33c4c 100644 --- a/markdown/bitburner.export.amt.md +++ b/markdown/bitburner.export.amt.md @@ -6,7 +6,7 @@ Amount of material exported -Signature: +**Signature:** ```typescript amt: string; diff --git a/markdown/bitburner.export.div.md b/markdown/bitburner.export.div.md index eb4c78f97..e869705fa 100644 --- a/markdown/bitburner.export.div.md +++ b/markdown/bitburner.export.div.md @@ -6,7 +6,7 @@ Division the material is being exported to -Signature: +**Signature:** ```typescript div: string; diff --git a/markdown/bitburner.export.loc.md b/markdown/bitburner.export.loc.md index 1c7f10616..204c9fcdc 100644 --- a/markdown/bitburner.export.loc.md +++ b/markdown/bitburner.export.loc.md @@ -6,7 +6,7 @@ City the material is being exported to -Signature: +**Signature:** ```typescript loc: CityName; diff --git a/markdown/bitburner.export.md b/markdown/bitburner.export.md index c0b20466a..274594fb3 100644 --- a/markdown/bitburner.export.md +++ b/markdown/bitburner.export.md @@ -6,7 +6,7 @@ Export order for a material -Signature: +**Signature:** ```typescript interface Export @@ -14,9 +14,9 @@ interface Export ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [amt](./bitburner.export.amt.md) | string | Amount of material exported | -| [div](./bitburner.export.div.md) | string | Division the material is being exported to | -| [loc](./bitburner.export.loc.md) | [CityName](./bitburner.cityname.md) | City the material is being exported to | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [amt](./bitburner.export.amt.md) | | string | Amount of material exported | +| [div](./bitburner.export.div.md) | | string | Division the material is being exported to | +| [loc](./bitburner.export.loc.md) | | [CityName](./bitburner.cityname.md) | City the material is being exported to | diff --git a/markdown/bitburner.factionworktype.md b/markdown/bitburner.factionworktype.md index cad32321b..b9c2d253b 100644 --- a/markdown/bitburner.factionworktype.md +++ b/markdown/bitburner.factionworktype.md @@ -5,7 +5,7 @@ ## FactionWorkType enum -Signature: +**Signature:** ```typescript declare enum FactionWorkType diff --git a/markdown/bitburner.filenameorpid.md b/markdown/bitburner.filenameorpid.md index df48b9af4..82fa317aa 100644 --- a/markdown/bitburner.filenameorpid.md +++ b/markdown/bitburner.filenameorpid.md @@ -5,7 +5,7 @@ ## FilenameOrPID type -Signature: +**Signature:** ```typescript type FilenameOrPID = number | string; diff --git a/markdown/bitburner.formulas.gang.md b/markdown/bitburner.formulas.gang.md index 6a2b07ff7..d3d892de8 100644 --- a/markdown/bitburner.formulas.gang.md +++ b/markdown/bitburner.formulas.gang.md @@ -6,7 +6,7 @@ Gang formulas -Signature: +**Signature:** ```typescript gang: GangFormulas; diff --git a/markdown/bitburner.formulas.hacking.md b/markdown/bitburner.formulas.hacking.md index 51407977d..53b5e48bd 100644 --- a/markdown/bitburner.formulas.hacking.md +++ b/markdown/bitburner.formulas.hacking.md @@ -6,7 +6,7 @@ Hacking formulas -Signature: +**Signature:** ```typescript hacking: HackingFormulas; diff --git a/markdown/bitburner.formulas.hacknetnodes.md b/markdown/bitburner.formulas.hacknetnodes.md index 6e264ea35..6fd43e875 100644 --- a/markdown/bitburner.formulas.hacknetnodes.md +++ b/markdown/bitburner.formulas.hacknetnodes.md @@ -6,7 +6,7 @@ Hacknet Nodes formulas -Signature: +**Signature:** ```typescript hacknetNodes: HacknetNodesFormulas; diff --git a/markdown/bitburner.formulas.hacknetservers.md b/markdown/bitburner.formulas.hacknetservers.md index 6b969f00e..4efb32354 100644 --- a/markdown/bitburner.formulas.hacknetservers.md +++ b/markdown/bitburner.formulas.hacknetservers.md @@ -6,7 +6,7 @@ Hacknet Servers formulas -Signature: +**Signature:** ```typescript hacknetServers: HacknetServersFormulas; diff --git a/markdown/bitburner.formulas.md b/markdown/bitburner.formulas.md index de287d02b..66aac71ce 100644 --- a/markdown/bitburner.formulas.md +++ b/markdown/bitburner.formulas.md @@ -6,7 +6,7 @@ Formulas API -Signature: +**Signature:** ```typescript export interface Formulas @@ -18,15 +18,15 @@ You need Formulas.exe on your home computer to use this API. ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [gang](./bitburner.formulas.gang.md) | [GangFormulas](./bitburner.gangformulas.md) | Gang formulas | -| [hacking](./bitburner.formulas.hacking.md) | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | -| [hacknetNodes](./bitburner.formulas.hacknetnodes.md) | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Nodes formulas | -| [hacknetServers](./bitburner.formulas.hacknetservers.md) | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Servers formulas | -| [reputation](./bitburner.formulas.reputation.md) | [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas | -| [skills](./bitburner.formulas.skills.md) | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | -| [work](./bitburner.formulas.work.md) | [WorkFormulas](./bitburner.workformulas.md) | Work formulas | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [gang](./bitburner.formulas.gang.md) | | [GangFormulas](./bitburner.gangformulas.md) | Gang formulas | +| [hacking](./bitburner.formulas.hacking.md) | | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | +| [hacknetNodes](./bitburner.formulas.hacknetnodes.md) | | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Nodes formulas | +| [hacknetServers](./bitburner.formulas.hacknetservers.md) | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Servers formulas | +| [reputation](./bitburner.formulas.reputation.md) | | [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas | +| [skills](./bitburner.formulas.skills.md) | | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | +| [work](./bitburner.formulas.work.md) | | [WorkFormulas](./bitburner.workformulas.md) | Work formulas | ## Methods diff --git a/markdown/bitburner.formulas.mockperson.md b/markdown/bitburner.formulas.mockperson.md index 4a1478dae..15e5bd288 100644 --- a/markdown/bitburner.formulas.mockperson.md +++ b/markdown/bitburner.formulas.mockperson.md @@ -4,12 +4,12 @@ ## Formulas.mockPerson() method -Signature: +**Signature:** ```typescript mockPerson(): Person; ``` -Returns: +**Returns:** [Person](./bitburner.person.md) diff --git a/markdown/bitburner.formulas.mockplayer.md b/markdown/bitburner.formulas.mockplayer.md index 395abcd43..062224d4e 100644 --- a/markdown/bitburner.formulas.mockplayer.md +++ b/markdown/bitburner.formulas.mockplayer.md @@ -4,12 +4,12 @@ ## Formulas.mockPlayer() method -Signature: +**Signature:** ```typescript mockPlayer(): Player; ``` -Returns: +**Returns:** [Player](./bitburner.player.md) diff --git a/markdown/bitburner.formulas.mockserver.md b/markdown/bitburner.formulas.mockserver.md index 0921e33cd..651db4bc4 100644 --- a/markdown/bitburner.formulas.mockserver.md +++ b/markdown/bitburner.formulas.mockserver.md @@ -4,12 +4,12 @@ ## Formulas.mockServer() method -Signature: +**Signature:** ```typescript mockServer(): Server; ``` -Returns: +**Returns:** [Server](./bitburner.server.md) diff --git a/markdown/bitburner.formulas.reputation.md b/markdown/bitburner.formulas.reputation.md index 647861041..518afa387 100644 --- a/markdown/bitburner.formulas.reputation.md +++ b/markdown/bitburner.formulas.reputation.md @@ -6,7 +6,7 @@ Reputation formulas -Signature: +**Signature:** ```typescript reputation: ReputationFormulas; diff --git a/markdown/bitburner.formulas.skills.md b/markdown/bitburner.formulas.skills.md index 5ea345a6c..16de88a83 100644 --- a/markdown/bitburner.formulas.skills.md +++ b/markdown/bitburner.formulas.skills.md @@ -6,7 +6,7 @@ Skills formulas -Signature: +**Signature:** ```typescript skills: SkillsFormulas; diff --git a/markdown/bitburner.formulas.work.md b/markdown/bitburner.formulas.work.md index 0ee012fb6..2507da940 100644 --- a/markdown/bitburner.formulas.work.md +++ b/markdown/bitburner.formulas.work.md @@ -6,7 +6,7 @@ Work formulas -Signature: +**Signature:** ```typescript work: WorkFormulas; diff --git a/markdown/bitburner.fragment.id.md b/markdown/bitburner.fragment.id.md index cf6e6d4f1..0e2dcee76 100644 --- a/markdown/bitburner.fragment.id.md +++ b/markdown/bitburner.fragment.id.md @@ -4,7 +4,7 @@ ## Fragment.id property -Signature: +**Signature:** ```typescript id: number; diff --git a/markdown/bitburner.fragment.limit.md b/markdown/bitburner.fragment.limit.md index b24873ef3..670dd96dd 100644 --- a/markdown/bitburner.fragment.limit.md +++ b/markdown/bitburner.fragment.limit.md @@ -4,7 +4,7 @@ ## Fragment.limit property -Signature: +**Signature:** ```typescript limit: number; diff --git a/markdown/bitburner.fragment.md b/markdown/bitburner.fragment.md index 909d721cf..0d39942f0 100644 --- a/markdown/bitburner.fragment.md +++ b/markdown/bitburner.fragment.md @@ -5,7 +5,7 @@ ## Fragment interface -Signature: +**Signature:** ```typescript interface Fragment @@ -13,11 +13,11 @@ interface Fragment ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [id](./bitburner.fragment.id.md) | number | | -| [limit](./bitburner.fragment.limit.md) | number | | -| [power](./bitburner.fragment.power.md) | number | | -| [shape](./bitburner.fragment.shape.md) | boolean\[\]\[\] | | -| [type](./bitburner.fragment.type.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [id](./bitburner.fragment.id.md) | | number | | +| [limit](./bitburner.fragment.limit.md) | | number | | +| [power](./bitburner.fragment.power.md) | | number | | +| [shape](./bitburner.fragment.shape.md) | | boolean\[\]\[\] | | +| [type](./bitburner.fragment.type.md) | | number | | diff --git a/markdown/bitburner.fragment.power.md b/markdown/bitburner.fragment.power.md index 59ce83d87..15aeb617a 100644 --- a/markdown/bitburner.fragment.power.md +++ b/markdown/bitburner.fragment.power.md @@ -4,7 +4,7 @@ ## Fragment.power property -Signature: +**Signature:** ```typescript power: number; diff --git a/markdown/bitburner.fragment.shape.md b/markdown/bitburner.fragment.shape.md index ffd1404e5..42fa94021 100644 --- a/markdown/bitburner.fragment.shape.md +++ b/markdown/bitburner.fragment.shape.md @@ -4,7 +4,7 @@ ## Fragment.shape property -Signature: +**Signature:** ```typescript shape: boolean[][]; diff --git a/markdown/bitburner.fragment.type.md b/markdown/bitburner.fragment.type.md index de88217bc..a2c392fe1 100644 --- a/markdown/bitburner.fragment.type.md +++ b/markdown/bitburner.fragment.type.md @@ -4,7 +4,7 @@ ## Fragment.type property -Signature: +**Signature:** ```typescript type: number; diff --git a/markdown/bitburner.gameinfo.commit.md b/markdown/bitburner.gameinfo.commit.md index f54c06d2b..4a93173b1 100644 --- a/markdown/bitburner.gameinfo.commit.md +++ b/markdown/bitburner.gameinfo.commit.md @@ -4,7 +4,7 @@ ## GameInfo.commit property -Signature: +**Signature:** ```typescript commit: string; diff --git a/markdown/bitburner.gameinfo.md b/markdown/bitburner.gameinfo.md index 135e8047f..7d258f240 100644 --- a/markdown/bitburner.gameinfo.md +++ b/markdown/bitburner.gameinfo.md @@ -6,7 +6,7 @@ Game Information -Signature: +**Signature:** ```typescript interface GameInfo @@ -14,9 +14,9 @@ interface GameInfo ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [commit](./bitburner.gameinfo.commit.md) | string | | -| [platform](./bitburner.gameinfo.platform.md) | string | | -| [version](./bitburner.gameinfo.version.md) | string | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [commit](./bitburner.gameinfo.commit.md) | | string | | +| [platform](./bitburner.gameinfo.platform.md) | | string | | +| [version](./bitburner.gameinfo.version.md) | | string | | diff --git a/markdown/bitburner.gameinfo.platform.md b/markdown/bitburner.gameinfo.platform.md index b8c96d41f..30ecc116a 100644 --- a/markdown/bitburner.gameinfo.platform.md +++ b/markdown/bitburner.gameinfo.platform.md @@ -4,7 +4,7 @@ ## GameInfo.platform property -Signature: +**Signature:** ```typescript platform: string; diff --git a/markdown/bitburner.gameinfo.version.md b/markdown/bitburner.gameinfo.version.md index 9b19ac008..b83c1fe87 100644 --- a/markdown/bitburner.gameinfo.version.md +++ b/markdown/bitburner.gameinfo.version.md @@ -4,7 +4,7 @@ ## GameInfo.version property -Signature: +**Signature:** ```typescript version: string; diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md index 1932ed0ba..49a05e819 100644 --- a/markdown/bitburner.gang.ascendmember.md +++ b/markdown/bitburner.gang.ascendmember.md @@ -6,7 +6,7 @@ Ascend a gang member. -Signature: +**Signature:** ```typescript ascendMember(memberName: string): GangMemberAscension | undefined; @@ -18,7 +18,7 @@ ascendMember(memberName: string): GangMemberAscension | undefined; | --- | --- | --- | | memberName | string | Name of member to ascend. | -Returns: +**Returns:** [GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined diff --git a/markdown/bitburner.gang.canrecruitmember.md b/markdown/bitburner.gang.canrecruitmember.md index d09a109ed..7b0b447c1 100644 --- a/markdown/bitburner.gang.canrecruitmember.md +++ b/markdown/bitburner.gang.canrecruitmember.md @@ -6,12 +6,12 @@ Check if you can recruit a new gang member. -Signature: +**Signature:** ```typescript canRecruitMember(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.creategang.md b/markdown/bitburner.gang.creategang.md index cf57b8a8a..696bbd4d9 100644 --- a/markdown/bitburner.gang.creategang.md +++ b/markdown/bitburner.gang.creategang.md @@ -6,7 +6,7 @@ Create a gang. -Signature: +**Signature:** ```typescript createGang(faction: string): boolean; @@ -18,7 +18,7 @@ createGang(faction: string): boolean; | --- | --- | --- | | faction | string | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.getascensionresult.md b/markdown/bitburner.gang.getascensionresult.md index 3e6787b21..6fef44dee 100644 --- a/markdown/bitburner.gang.getascensionresult.md +++ b/markdown/bitburner.gang.getascensionresult.md @@ -6,7 +6,7 @@ Get the result of an ascension without ascending. -Signature: +**Signature:** ```typescript getAscensionResult(memberName: string): GangMemberAscension | undefined; @@ -18,7 +18,7 @@ getAscensionResult(memberName: string): GangMemberAscension | undefined; | --- | --- | --- | | memberName | string | Name of member. | -Returns: +**Returns:** [GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined diff --git a/markdown/bitburner.gang.getbonustime.md b/markdown/bitburner.gang.getbonustime.md index 89d8dd9b6..b18531489 100644 --- a/markdown/bitburner.gang.getbonustime.md +++ b/markdown/bitburner.gang.getbonustime.md @@ -6,12 +6,12 @@ Get bonus time. -Signature: +**Signature:** ```typescript getBonusTime(): number; ``` -Returns: +**Returns:** number @@ -25,5 +25,5 @@ Returns the amount of accumulated “bonus time” (milliseconds) for the Gang m “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. +“Bonus time” makes the game progress faster, up to 25x the normal speed. diff --git a/markdown/bitburner.gang.getchancetowinclash.md b/markdown/bitburner.gang.getchancetowinclash.md index fa6d46455..604944996 100644 --- a/markdown/bitburner.gang.getchancetowinclash.md +++ b/markdown/bitburner.gang.getchancetowinclash.md @@ -6,7 +6,7 @@ Get chance to win clash with other gang. -Signature: +**Signature:** ```typescript getChanceToWinClash(gangName: string): number; @@ -18,7 +18,7 @@ getChanceToWinClash(gangName: string): number; | --- | --- | --- | | gangName | string | Target gang | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gang.getequipmentcost.md b/markdown/bitburner.gang.getequipmentcost.md index 8deb184e4..f1573f511 100644 --- a/markdown/bitburner.gang.getequipmentcost.md +++ b/markdown/bitburner.gang.getequipmentcost.md @@ -6,7 +6,7 @@ Get cost of equipment. -Signature: +**Signature:** ```typescript getEquipmentCost(equipName: string): number; @@ -18,7 +18,7 @@ getEquipmentCost(equipName: string): number; | --- | --- | --- | | equipName | string | Name of equipment. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gang.getequipmentnames.md b/markdown/bitburner.gang.getequipmentnames.md index 931d31d76..6684859c7 100644 --- a/markdown/bitburner.gang.getequipmentnames.md +++ b/markdown/bitburner.gang.getequipmentnames.md @@ -6,12 +6,12 @@ List equipment names. -Signature: +**Signature:** ```typescript getEquipmentNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.gang.getequipmentstats.md b/markdown/bitburner.gang.getequipmentstats.md index d78d067e5..2649721cb 100644 --- a/markdown/bitburner.gang.getequipmentstats.md +++ b/markdown/bitburner.gang.getequipmentstats.md @@ -6,7 +6,7 @@ Get stats of an equipment. -Signature: +**Signature:** ```typescript getEquipmentStats(equipName: string): EquipmentStats; @@ -18,7 +18,7 @@ getEquipmentStats(equipName: string): EquipmentStats; | --- | --- | --- | | equipName | string | Name of equipment. | -Returns: +**Returns:** [EquipmentStats](./bitburner.equipmentstats.md) diff --git a/markdown/bitburner.gang.getequipmenttype.md b/markdown/bitburner.gang.getequipmenttype.md index 0958e5696..aa3bfdc14 100644 --- a/markdown/bitburner.gang.getequipmenttype.md +++ b/markdown/bitburner.gang.getequipmenttype.md @@ -6,7 +6,7 @@ Get type of an equipment. -Signature: +**Signature:** ```typescript getEquipmentType(equipName: string): string; @@ -18,7 +18,7 @@ getEquipmentType(equipName: string): string; | --- | --- | --- | | equipName | string | Name of equipment. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.gang.getganginformation.md b/markdown/bitburner.gang.getganginformation.md index 5e325c073..54d9ec7bb 100644 --- a/markdown/bitburner.gang.getganginformation.md +++ b/markdown/bitburner.gang.getganginformation.md @@ -6,12 +6,12 @@ Get information about your gang. -Signature: +**Signature:** ```typescript getGangInformation(): GangGenInfo; ``` -Returns: +**Returns:** [GangGenInfo](./bitburner.ganggeninfo.md) diff --git a/markdown/bitburner.gang.getmemberinformation.md b/markdown/bitburner.gang.getmemberinformation.md index 13033bfaa..76ce8db05 100644 --- a/markdown/bitburner.gang.getmemberinformation.md +++ b/markdown/bitburner.gang.getmemberinformation.md @@ -6,7 +6,7 @@ Get information about a specific gang member. -Signature: +**Signature:** ```typescript getMemberInformation(name: string): GangMemberInfo; @@ -18,7 +18,7 @@ getMemberInformation(name: string): GangMemberInfo; | --- | --- | --- | | name | string | Name of member. | -Returns: +**Returns:** [GangMemberInfo](./bitburner.gangmemberinfo.md) diff --git a/markdown/bitburner.gang.getmembernames.md b/markdown/bitburner.gang.getmembernames.md index 08a766c42..bc92bde6f 100644 --- a/markdown/bitburner.gang.getmembernames.md +++ b/markdown/bitburner.gang.getmembernames.md @@ -6,12 +6,12 @@ List all gang members. -Signature: +**Signature:** ```typescript getMemberNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.gang.getotherganginformation.md b/markdown/bitburner.gang.getotherganginformation.md index 6764033f3..d260ae011 100644 --- a/markdown/bitburner.gang.getotherganginformation.md +++ b/markdown/bitburner.gang.getotherganginformation.md @@ -6,12 +6,12 @@ Get information about the other gangs. -Signature: +**Signature:** ```typescript getOtherGangInformation(): GangOtherInfo; ``` -Returns: +**Returns:** [GangOtherInfo](./bitburner.gangotherinfo.md) diff --git a/markdown/bitburner.gang.gettasknames.md b/markdown/bitburner.gang.gettasknames.md index 4e1b1d885..8b13fa38d 100644 --- a/markdown/bitburner.gang.gettasknames.md +++ b/markdown/bitburner.gang.gettasknames.md @@ -6,12 +6,12 @@ List member task names. -Signature: +**Signature:** ```typescript getTaskNames(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.gang.gettaskstats.md b/markdown/bitburner.gang.gettaskstats.md index cfd2a62a5..c80e52687 100644 --- a/markdown/bitburner.gang.gettaskstats.md +++ b/markdown/bitburner.gang.gettaskstats.md @@ -6,7 +6,7 @@ Get stats of a task. -Signature: +**Signature:** ```typescript getTaskStats(name: string): GangTaskStats; @@ -18,7 +18,7 @@ getTaskStats(name: string): GangTaskStats; | --- | --- | --- | | name | string | Name of the task. | -Returns: +**Returns:** [GangTaskStats](./bitburner.gangtaskstats.md) diff --git a/markdown/bitburner.gang.ingang.md b/markdown/bitburner.gang.ingang.md index 4cd0021f9..d1470ecbc 100644 --- a/markdown/bitburner.gang.ingang.md +++ b/markdown/bitburner.gang.ingang.md @@ -6,12 +6,12 @@ Check if you're in a gang. -Signature: +**Signature:** ```typescript inGang(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md index de2e20ca5..9f825ef5a 100644 --- a/markdown/bitburner.gang.md +++ b/markdown/bitburner.gang.md @@ -6,7 +6,7 @@ Gang API -Signature: +**Signature:** ```typescript export interface Gang diff --git a/markdown/bitburner.gang.purchaseequipment.md b/markdown/bitburner.gang.purchaseequipment.md index c5cb20db2..0d8206691 100644 --- a/markdown/bitburner.gang.purchaseequipment.md +++ b/markdown/bitburner.gang.purchaseequipment.md @@ -6,7 +6,7 @@ Purchase an equipment for a gang member. -Signature: +**Signature:** ```typescript purchaseEquipment(memberName: string, equipName: string): boolean; @@ -19,7 +19,7 @@ purchaseEquipment(memberName: string, equipName: string): boolean; | memberName | string | Name of Gang member to purchase the equipment for. | | equipName | string | Name of Equipment/Augmentation to purchase. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.recruitmember.md b/markdown/bitburner.gang.recruitmember.md index d74689ed8..3468d4f35 100644 --- a/markdown/bitburner.gang.recruitmember.md +++ b/markdown/bitburner.gang.recruitmember.md @@ -6,7 +6,7 @@ Recruit a new gang member. -Signature: +**Signature:** ```typescript recruitMember(name: string): boolean; @@ -18,7 +18,7 @@ recruitMember(name: string): boolean; | --- | --- | --- | | name | string | Name of member to recruit. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.setmembertask.md b/markdown/bitburner.gang.setmembertask.md index 972af190b..d6981dd2a 100644 --- a/markdown/bitburner.gang.setmembertask.md +++ b/markdown/bitburner.gang.setmembertask.md @@ -6,7 +6,7 @@ Set gang member to task. -Signature: +**Signature:** ```typescript setMemberTask(memberName: string, taskName: string): boolean; @@ -19,7 +19,7 @@ setMemberTask(memberName: string, taskName: string): boolean; | memberName | string | Name of Gang member to assign. | | taskName | string | Task to assign. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.gang.setterritorywarfare.md b/markdown/bitburner.gang.setterritorywarfare.md index 068b0abce..70e3f0c39 100644 --- a/markdown/bitburner.gang.setterritorywarfare.md +++ b/markdown/bitburner.gang.setterritorywarfare.md @@ -6,7 +6,7 @@ Enable/Disable territory warfare. -Signature: +**Signature:** ```typescript setTerritoryWarfare(engage: boolean): void; @@ -18,7 +18,7 @@ setTerritoryWarfare(engage: boolean): void; | --- | --- | --- | | engage | boolean | Whether or not to engage in territory warfare. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.gangformulas.ascensionmultiplier.md b/markdown/bitburner.gangformulas.ascensionmultiplier.md index b654ddf26..8b2148a7c 100644 --- a/markdown/bitburner.gangformulas.ascensionmultiplier.md +++ b/markdown/bitburner.gangformulas.ascensionmultiplier.md @@ -6,7 +6,7 @@ Calculate ascension mult. -Signature: +**Signature:** ```typescript ascensionMultiplier(points: number): number; @@ -18,7 +18,7 @@ ascensionMultiplier(points: number): number; | --- | --- | --- | | points | number | Amount of ascension points. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gangformulas.ascensionpointsgain.md b/markdown/bitburner.gangformulas.ascensionpointsgain.md index 796be6b58..6f06887a6 100644 --- a/markdown/bitburner.gangformulas.ascensionpointsgain.md +++ b/markdown/bitburner.gangformulas.ascensionpointsgain.md @@ -6,7 +6,7 @@ Calculate ascension point gain. -Signature: +**Signature:** ```typescript ascensionPointsGain(exp: number): number; @@ -18,7 +18,7 @@ ascensionPointsGain(exp: number): number; | --- | --- | --- | | exp | number | Experience point before ascension. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gangformulas.md b/markdown/bitburner.gangformulas.md index eea043ad0..3d58751fa 100644 --- a/markdown/bitburner.gangformulas.md +++ b/markdown/bitburner.gangformulas.md @@ -6,7 +6,7 @@ Gang formulas -Signature: +**Signature:** ```typescript interface GangFormulas diff --git a/markdown/bitburner.gangformulas.moneygain.md b/markdown/bitburner.gangformulas.moneygain.md index 4eec2828a..58717f7df 100644 --- a/markdown/bitburner.gangformulas.moneygain.md +++ b/markdown/bitburner.gangformulas.moneygain.md @@ -6,7 +6,7 @@ Calculate money gain per tick. -Signature: +**Signature:** ```typescript moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; @@ -20,7 +20,7 @@ moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): numbe | member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | | task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gangformulas.respectgain.md b/markdown/bitburner.gangformulas.respectgain.md index 3bc6e4f49..e6fadaa9a 100644 --- a/markdown/bitburner.gangformulas.respectgain.md +++ b/markdown/bitburner.gangformulas.respectgain.md @@ -6,7 +6,7 @@ Calculate respect gain per tick. -Signature: +**Signature:** ```typescript respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; @@ -20,7 +20,7 @@ respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): num | member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Gang info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | | task | [GangTaskStats](./bitburner.gangtaskstats.md) | Gang info from [getTaskStats](./bitburner.gang.gettaskstats.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gangformulas.wantedlevelgain.md b/markdown/bitburner.gangformulas.wantedlevelgain.md index f86d30fef..f3400e600 100644 --- a/markdown/bitburner.gangformulas.wantedlevelgain.md +++ b/markdown/bitburner.gangformulas.wantedlevelgain.md @@ -6,7 +6,7 @@ Calculate wanted gain per tick. -Signature: +**Signature:** ```typescript wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; @@ -20,7 +20,7 @@ wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): | member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | | task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.gangformulas.wantedpenalty.md b/markdown/bitburner.gangformulas.wantedpenalty.md index 966de0885..295af76f8 100644 --- a/markdown/bitburner.gangformulas.wantedpenalty.md +++ b/markdown/bitburner.gangformulas.wantedpenalty.md @@ -6,7 +6,7 @@ Calculate the wanted penalty. -Signature: +**Signature:** ```typescript wantedPenalty(gang: GangGenInfo): number; @@ -18,7 +18,7 @@ wantedPenalty(gang: GangGenInfo): number; | --- | --- | --- | | gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ganggeninfo.faction.md b/markdown/bitburner.ganggeninfo.faction.md index 0b36ac034..0707407c6 100644 --- a/markdown/bitburner.ganggeninfo.faction.md +++ b/markdown/bitburner.ganggeninfo.faction.md @@ -6,7 +6,7 @@ Name of faction that the gang belongs to ("Slum Snakes", etc.) -Signature: +**Signature:** ```typescript faction: string; diff --git a/markdown/bitburner.ganggeninfo.ishacking.md b/markdown/bitburner.ganggeninfo.ishacking.md index e92362c16..12da3e697 100644 --- a/markdown/bitburner.ganggeninfo.ishacking.md +++ b/markdown/bitburner.ganggeninfo.ishacking.md @@ -6,7 +6,7 @@ Indicating whether or not it's a hacking gang -Signature: +**Signature:** ```typescript isHacking: boolean; diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md index 4bfa5686f..0d116966d 100644 --- a/markdown/bitburner.ganggeninfo.md +++ b/markdown/bitburner.ganggeninfo.md @@ -6,7 +6,7 @@ Gang general info. -Signature: +**Signature:** ```typescript interface GangGenInfo @@ -14,18 +14,18 @@ interface GangGenInfo ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [faction](./bitburner.ganggeninfo.faction.md) | string | Name of faction that the gang belongs to ("Slum Snakes", etc.) | -| [isHacking](./bitburner.ganggeninfo.ishacking.md) | boolean | Indicating whether or not it's a hacking gang | -| [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | number | Money earned per game cycle | -| [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 game cycle | -| [territory](./bitburner.ganggeninfo.territory.md) | number | Amount of territory held | -| [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) | number | Clash chance | -| [territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) | boolean | Indicating if territory warfare is enabled | -| [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) | number | Gang's wanted level | -| [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) | number | Wanted level gained/lost per game cycle (negative for losses) | -| [wantedPenalty](./bitburner.ganggeninfo.wantedpenalty.md) | number | Number indicating the current wanted penalty | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [faction](./bitburner.ganggeninfo.faction.md) | | string | Name of faction that the gang belongs to ("Slum Snakes", etc.) | +| [isHacking](./bitburner.ganggeninfo.ishacking.md) | | boolean | Indicating whether or not it's a hacking gang | +| [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | | number | Money earned per game cycle | +| [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 game cycle | +| [territory](./bitburner.ganggeninfo.territory.md) | | number | Amount of territory held | +| [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) | | number | Clash chance | +| [territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) | | boolean | Indicating if territory warfare is enabled | +| [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) | | number | Gang's wanted level | +| [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) | | number | Wanted level gained/lost per game cycle (negative for losses) | +| [wantedPenalty](./bitburner.ganggeninfo.wantedpenalty.md) | | number | Number indicating the current wanted penalty | diff --git a/markdown/bitburner.ganggeninfo.moneygainrate.md b/markdown/bitburner.ganggeninfo.moneygainrate.md index 4045ca547..38a73d5f5 100644 --- a/markdown/bitburner.ganggeninfo.moneygainrate.md +++ b/markdown/bitburner.ganggeninfo.moneygainrate.md @@ -6,7 +6,7 @@ Money earned per game cycle -Signature: +**Signature:** ```typescript moneyGainRate: number; diff --git a/markdown/bitburner.ganggeninfo.power.md b/markdown/bitburner.ganggeninfo.power.md index 013893ba8..822fdb899 100644 --- a/markdown/bitburner.ganggeninfo.power.md +++ b/markdown/bitburner.ganggeninfo.power.md @@ -6,7 +6,7 @@ Gang's power for territory warfare -Signature: +**Signature:** ```typescript power: number; diff --git a/markdown/bitburner.ganggeninfo.respect.md b/markdown/bitburner.ganggeninfo.respect.md index 981fd3014..0e77e5d3a 100644 --- a/markdown/bitburner.ganggeninfo.respect.md +++ b/markdown/bitburner.ganggeninfo.respect.md @@ -6,7 +6,7 @@ Gang's respect -Signature: +**Signature:** ```typescript respect: number; diff --git a/markdown/bitburner.ganggeninfo.respectgainrate.md b/markdown/bitburner.ganggeninfo.respectgainrate.md index c1046e588..103721da9 100644 --- a/markdown/bitburner.ganggeninfo.respectgainrate.md +++ b/markdown/bitburner.ganggeninfo.respectgainrate.md @@ -6,7 +6,7 @@ Respect earned per game cycle -Signature: +**Signature:** ```typescript respectGainRate: number; diff --git a/markdown/bitburner.ganggeninfo.territory.md b/markdown/bitburner.ganggeninfo.territory.md index 5bd6f7ece..9c16925a8 100644 --- a/markdown/bitburner.ganggeninfo.territory.md +++ b/markdown/bitburner.ganggeninfo.territory.md @@ -6,7 +6,7 @@ Amount of territory held -Signature: +**Signature:** ```typescript territory: number; diff --git a/markdown/bitburner.ganggeninfo.territoryclashchance.md b/markdown/bitburner.ganggeninfo.territoryclashchance.md index 179bf2381..b9477c9fb 100644 --- a/markdown/bitburner.ganggeninfo.territoryclashchance.md +++ b/markdown/bitburner.ganggeninfo.territoryclashchance.md @@ -6,7 +6,7 @@ Clash chance -Signature: +**Signature:** ```typescript territoryClashChance: number; diff --git a/markdown/bitburner.ganggeninfo.territorywarfareengaged.md b/markdown/bitburner.ganggeninfo.territorywarfareengaged.md index d0f4a02f0..7582ebf7a 100644 --- a/markdown/bitburner.ganggeninfo.territorywarfareengaged.md +++ b/markdown/bitburner.ganggeninfo.territorywarfareengaged.md @@ -6,7 +6,7 @@ Indicating if territory warfare is enabled -Signature: +**Signature:** ```typescript territoryWarfareEngaged: boolean; diff --git a/markdown/bitburner.ganggeninfo.wantedlevel.md b/markdown/bitburner.ganggeninfo.wantedlevel.md index 62e803bd4..fc1161ea4 100644 --- a/markdown/bitburner.ganggeninfo.wantedlevel.md +++ b/markdown/bitburner.ganggeninfo.wantedlevel.md @@ -6,7 +6,7 @@ Gang's wanted level -Signature: +**Signature:** ```typescript wantedLevel: number; diff --git a/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md index 20f3e1fa3..40d858c2c 100644 --- a/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md +++ b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md @@ -6,7 +6,7 @@ Wanted level gained/lost per game cycle (negative for losses) -Signature: +**Signature:** ```typescript wantedLevelGainRate: number; diff --git a/markdown/bitburner.ganggeninfo.wantedpenalty.md b/markdown/bitburner.ganggeninfo.wantedpenalty.md index 17719bd2a..db21fb90e 100644 --- a/markdown/bitburner.ganggeninfo.wantedpenalty.md +++ b/markdown/bitburner.ganggeninfo.wantedpenalty.md @@ -6,7 +6,7 @@ Number indicating the current wanted penalty -Signature: +**Signature:** ```typescript wantedPenalty: number; diff --git a/markdown/bitburner.gangmemberascension.agi.md b/markdown/bitburner.gangmemberascension.agi.md index 75e15dc39..f5252ccaa 100644 --- a/markdown/bitburner.gangmemberascension.agi.md +++ b/markdown/bitburner.gangmemberascension.agi.md @@ -6,7 +6,7 @@ Agility multiplier gained from ascending -Signature: +**Signature:** ```typescript agi: number; diff --git a/markdown/bitburner.gangmemberascension.cha.md b/markdown/bitburner.gangmemberascension.cha.md index 24eb2cb04..2434cbe36 100644 --- a/markdown/bitburner.gangmemberascension.cha.md +++ b/markdown/bitburner.gangmemberascension.cha.md @@ -6,7 +6,7 @@ Charisma multiplier gained from ascending -Signature: +**Signature:** ```typescript cha: number; diff --git a/markdown/bitburner.gangmemberascension.def.md b/markdown/bitburner.gangmemberascension.def.md index 3ed9ae655..32f08317c 100644 --- a/markdown/bitburner.gangmemberascension.def.md +++ b/markdown/bitburner.gangmemberascension.def.md @@ -6,7 +6,7 @@ Defense multiplier gained from ascending -Signature: +**Signature:** ```typescript def: number; diff --git a/markdown/bitburner.gangmemberascension.dex.md b/markdown/bitburner.gangmemberascension.dex.md index d081d35a6..fb5de53bc 100644 --- a/markdown/bitburner.gangmemberascension.dex.md +++ b/markdown/bitburner.gangmemberascension.dex.md @@ -6,7 +6,7 @@ Dexterity multiplier gained from ascending -Signature: +**Signature:** ```typescript dex: number; diff --git a/markdown/bitburner.gangmemberascension.hack.md b/markdown/bitburner.gangmemberascension.hack.md index b42e99ebb..ad34eab91 100644 --- a/markdown/bitburner.gangmemberascension.hack.md +++ b/markdown/bitburner.gangmemberascension.hack.md @@ -6,7 +6,7 @@ Hacking multiplier gained from ascending -Signature: +**Signature:** ```typescript hack: number; diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md index 8553bde4b..ecb555ff0 100644 --- a/markdown/bitburner.gangmemberascension.md +++ b/markdown/bitburner.gangmemberascension.md @@ -5,7 +5,7 @@ ## GangMemberAscension interface -Signature: +**Signature:** ```typescript interface GangMemberAscension @@ -13,13 +13,13 @@ interface GangMemberAscension ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agi](./bitburner.gangmemberascension.agi.md) | number | Agility multiplier gained from ascending | -| [cha](./bitburner.gangmemberascension.cha.md) | number | Charisma multiplier gained from ascending | -| [def](./bitburner.gangmemberascension.def.md) | number | Defense multiplier gained from ascending | -| [dex](./bitburner.gangmemberascension.dex.md) | number | Dexterity multiplier gained from ascending | -| [hack](./bitburner.gangmemberascension.hack.md) | number | Hacking multiplier gained from ascending | -| [respect](./bitburner.gangmemberascension.respect.md) | number | Amount of respect lost from ascending | -| [str](./bitburner.gangmemberascension.str.md) | number | Strength multiplier gained from ascending | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agi](./bitburner.gangmemberascension.agi.md) | | number | Agility multiplier gained from ascending | +| [cha](./bitburner.gangmemberascension.cha.md) | | number | Charisma multiplier gained from ascending | +| [def](./bitburner.gangmemberascension.def.md) | | number | Defense multiplier gained from ascending | +| [dex](./bitburner.gangmemberascension.dex.md) | | number | Dexterity multiplier gained from ascending | +| [hack](./bitburner.gangmemberascension.hack.md) | | number | Hacking multiplier gained from ascending | +| [respect](./bitburner.gangmemberascension.respect.md) | | number | Amount of respect lost from ascending | +| [str](./bitburner.gangmemberascension.str.md) | | number | Strength multiplier gained from ascending | diff --git a/markdown/bitburner.gangmemberascension.respect.md b/markdown/bitburner.gangmemberascension.respect.md index 45b3bd042..4d0258a24 100644 --- a/markdown/bitburner.gangmemberascension.respect.md +++ b/markdown/bitburner.gangmemberascension.respect.md @@ -6,7 +6,7 @@ Amount of respect lost from ascending -Signature: +**Signature:** ```typescript respect: number; diff --git a/markdown/bitburner.gangmemberascension.str.md b/markdown/bitburner.gangmemberascension.str.md index 647d4ca28..e882bd958 100644 --- a/markdown/bitburner.gangmemberascension.str.md +++ b/markdown/bitburner.gangmemberascension.str.md @@ -6,7 +6,7 @@ Strength multiplier gained from ascending -Signature: +**Signature:** ```typescript str: number; diff --git a/markdown/bitburner.gangmemberinfo.agi.md b/markdown/bitburner.gangmemberinfo.agi.md index 90deb5f11..94a09b2d5 100644 --- a/markdown/bitburner.gangmemberinfo.agi.md +++ b/markdown/bitburner.gangmemberinfo.agi.md @@ -6,7 +6,7 @@ Agility skill level -Signature: +**Signature:** ```typescript agi: number; diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_mult.md b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md index d3c2b2451..0ac098887 100644 --- a/markdown/bitburner.gangmemberinfo.agi_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md @@ -6,7 +6,7 @@ Agility multiplier from ascensions -Signature: +**Signature:** ```typescript agi_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_points.md b/markdown/bitburner.gangmemberinfo.agi_asc_points.md index d1c3d5d8b..bbfcde7b2 100644 --- a/markdown/bitburner.gangmemberinfo.agi_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.agi_asc_points.md @@ -6,7 +6,7 @@ Total earned agility experience -Signature: +**Signature:** ```typescript agi_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.agi_exp.md b/markdown/bitburner.gangmemberinfo.agi_exp.md index c5e9be1e0..d1927b3e0 100644 --- a/markdown/bitburner.gangmemberinfo.agi_exp.md +++ b/markdown/bitburner.gangmemberinfo.agi_exp.md @@ -6,7 +6,7 @@ Current agility experience -Signature: +**Signature:** ```typescript agi_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.agi_mult.md b/markdown/bitburner.gangmemberinfo.agi_mult.md index f44c859f0..3624bb855 100644 --- a/markdown/bitburner.gangmemberinfo.agi_mult.md +++ b/markdown/bitburner.gangmemberinfo.agi_mult.md @@ -6,7 +6,7 @@ Agility multiplier from equipment -Signature: +**Signature:** ```typescript agi_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.augmentations.md b/markdown/bitburner.gangmemberinfo.augmentations.md index 64ae3a6f3..a202d6112 100644 --- a/markdown/bitburner.gangmemberinfo.augmentations.md +++ b/markdown/bitburner.gangmemberinfo.augmentations.md @@ -4,7 +4,7 @@ ## GangMemberInfo.augmentations property -Signature: +**Signature:** ```typescript augmentations: string[]; diff --git a/markdown/bitburner.gangmemberinfo.cha.md b/markdown/bitburner.gangmemberinfo.cha.md index 1f1ef5676..7075627aa 100644 --- a/markdown/bitburner.gangmemberinfo.cha.md +++ b/markdown/bitburner.gangmemberinfo.cha.md @@ -6,7 +6,7 @@ Charisma skill level -Signature: +**Signature:** ```typescript cha: number; diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_mult.md b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md index fffb9ccbd..2db26514b 100644 --- a/markdown/bitburner.gangmemberinfo.cha_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md @@ -6,7 +6,7 @@ Charisma multiplier from ascensions -Signature: +**Signature:** ```typescript cha_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_points.md b/markdown/bitburner.gangmemberinfo.cha_asc_points.md index 79a736e04..92c7c94c4 100644 --- a/markdown/bitburner.gangmemberinfo.cha_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.cha_asc_points.md @@ -6,7 +6,7 @@ Total earned charisma experience -Signature: +**Signature:** ```typescript cha_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.cha_exp.md b/markdown/bitburner.gangmemberinfo.cha_exp.md index 77f6e0829..e49eb1902 100644 --- a/markdown/bitburner.gangmemberinfo.cha_exp.md +++ b/markdown/bitburner.gangmemberinfo.cha_exp.md @@ -6,7 +6,7 @@ Current charisma experience -Signature: +**Signature:** ```typescript cha_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.cha_mult.md b/markdown/bitburner.gangmemberinfo.cha_mult.md index fc68dffbc..0d03ed295 100644 --- a/markdown/bitburner.gangmemberinfo.cha_mult.md +++ b/markdown/bitburner.gangmemberinfo.cha_mult.md @@ -6,7 +6,7 @@ Charisma multiplier from equipment -Signature: +**Signature:** ```typescript cha_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.def.md b/markdown/bitburner.gangmemberinfo.def.md index e4b278562..40114348a 100644 --- a/markdown/bitburner.gangmemberinfo.def.md +++ b/markdown/bitburner.gangmemberinfo.def.md @@ -6,7 +6,7 @@ Defense skill level -Signature: +**Signature:** ```typescript def: number; diff --git a/markdown/bitburner.gangmemberinfo.def_asc_mult.md b/markdown/bitburner.gangmemberinfo.def_asc_mult.md index d21d98510..00b6e57de 100644 --- a/markdown/bitburner.gangmemberinfo.def_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.def_asc_mult.md @@ -6,7 +6,7 @@ Defense multiplier from ascensions -Signature: +**Signature:** ```typescript def_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.def_asc_points.md b/markdown/bitburner.gangmemberinfo.def_asc_points.md index bcd5d4fe2..5b6007823 100644 --- a/markdown/bitburner.gangmemberinfo.def_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.def_asc_points.md @@ -6,7 +6,7 @@ Total earned defense experience -Signature: +**Signature:** ```typescript def_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.def_exp.md b/markdown/bitburner.gangmemberinfo.def_exp.md index 5910078a4..2eb6d4d71 100644 --- a/markdown/bitburner.gangmemberinfo.def_exp.md +++ b/markdown/bitburner.gangmemberinfo.def_exp.md @@ -6,7 +6,7 @@ Current defense experience -Signature: +**Signature:** ```typescript def_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.def_mult.md b/markdown/bitburner.gangmemberinfo.def_mult.md index 82799b327..a628577cb 100644 --- a/markdown/bitburner.gangmemberinfo.def_mult.md +++ b/markdown/bitburner.gangmemberinfo.def_mult.md @@ -6,7 +6,7 @@ Defense multiplier from equipment -Signature: +**Signature:** ```typescript def_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.dex.md b/markdown/bitburner.gangmemberinfo.dex.md index e610fadab..9f7e9f3e8 100644 --- a/markdown/bitburner.gangmemberinfo.dex.md +++ b/markdown/bitburner.gangmemberinfo.dex.md @@ -6,7 +6,7 @@ Dexterity skill level -Signature: +**Signature:** ```typescript dex: number; diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_mult.md b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md index 79c2d80e6..c69e097f1 100644 --- a/markdown/bitburner.gangmemberinfo.dex_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md @@ -6,7 +6,7 @@ Dexterity multiplier from ascensions -Signature: +**Signature:** ```typescript dex_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_points.md b/markdown/bitburner.gangmemberinfo.dex_asc_points.md index d66448989..1a33578ac 100644 --- a/markdown/bitburner.gangmemberinfo.dex_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.dex_asc_points.md @@ -6,7 +6,7 @@ Total earned dexterity experience -Signature: +**Signature:** ```typescript dex_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.dex_exp.md b/markdown/bitburner.gangmemberinfo.dex_exp.md index ee7dafe70..a6b7697a5 100644 --- a/markdown/bitburner.gangmemberinfo.dex_exp.md +++ b/markdown/bitburner.gangmemberinfo.dex_exp.md @@ -6,7 +6,7 @@ Current dexterity experience -Signature: +**Signature:** ```typescript dex_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.dex_mult.md b/markdown/bitburner.gangmemberinfo.dex_mult.md index 4cdf259b0..cc6c22073 100644 --- a/markdown/bitburner.gangmemberinfo.dex_mult.md +++ b/markdown/bitburner.gangmemberinfo.dex_mult.md @@ -6,7 +6,7 @@ Dexterity multiplier from equipment -Signature: +**Signature:** ```typescript dex_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.earnedrespect.md b/markdown/bitburner.gangmemberinfo.earnedrespect.md index 561b98833..5dd4152a2 100644 --- a/markdown/bitburner.gangmemberinfo.earnedrespect.md +++ b/markdown/bitburner.gangmemberinfo.earnedrespect.md @@ -4,7 +4,7 @@ ## GangMemberInfo.earnedRespect property -Signature: +**Signature:** ```typescript earnedRespect: number; diff --git a/markdown/bitburner.gangmemberinfo.hack.md b/markdown/bitburner.gangmemberinfo.hack.md index 8e133a4dc..1c12d203a 100644 --- a/markdown/bitburner.gangmemberinfo.hack.md +++ b/markdown/bitburner.gangmemberinfo.hack.md @@ -6,7 +6,7 @@ Hack skill level -Signature: +**Signature:** ```typescript hack: number; diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_mult.md b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md index bc554e6bc..e8f14c9db 100644 --- a/markdown/bitburner.gangmemberinfo.hack_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md @@ -6,7 +6,7 @@ Hack multiplier from ascensions -Signature: +**Signature:** ```typescript hack_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_points.md b/markdown/bitburner.gangmemberinfo.hack_asc_points.md index 1c825d553..7e31485e6 100644 --- a/markdown/bitburner.gangmemberinfo.hack_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.hack_asc_points.md @@ -6,7 +6,7 @@ Total earned hack experience -Signature: +**Signature:** ```typescript hack_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.hack_exp.md b/markdown/bitburner.gangmemberinfo.hack_exp.md index b8ec2236b..7d41c398e 100644 --- a/markdown/bitburner.gangmemberinfo.hack_exp.md +++ b/markdown/bitburner.gangmemberinfo.hack_exp.md @@ -6,7 +6,7 @@ Current hack experience -Signature: +**Signature:** ```typescript hack_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.hack_mult.md b/markdown/bitburner.gangmemberinfo.hack_mult.md index f30e70624..d8e9c6753 100644 --- a/markdown/bitburner.gangmemberinfo.hack_mult.md +++ b/markdown/bitburner.gangmemberinfo.hack_mult.md @@ -6,7 +6,7 @@ Hack multiplier from equipment -Signature: +**Signature:** ```typescript hack_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md index 82f65eb01..4fdcf904f 100644 --- a/markdown/bitburner.gangmemberinfo.md +++ b/markdown/bitburner.gangmemberinfo.md @@ -5,7 +5,7 @@ ## GangMemberInfo interface -Signature: +**Signature:** ```typescript interface GangMemberInfo @@ -13,44 +13,44 @@ interface GangMemberInfo ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) | number | Agility multiplier from ascensions | -| [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) | number | Total earned agility experience | -| [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) | number | Current agility experience | -| [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) | number | Agility multiplier from equipment | -| [agi](./bitburner.gangmemberinfo.agi.md) | number | Agility skill level | -| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | string\[\] | | -| [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) | number | Charisma multiplier from ascensions | -| [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) | number | Total earned charisma experience | -| [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) | number | Current charisma experience | -| [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) | number | Charisma multiplier from equipment | -| [cha](./bitburner.gangmemberinfo.cha.md) | number | Charisma skill level | -| [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) | number | Defense multiplier from ascensions | -| [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) | number | Total earned defense experience | -| [def\_exp](./bitburner.gangmemberinfo.def_exp.md) | number | Current defense experience | -| [def\_mult](./bitburner.gangmemberinfo.def_mult.md) | number | Defense multiplier from equipment | -| [def](./bitburner.gangmemberinfo.def.md) | number | Defense skill level | -| [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) | number | Dexterity multiplier from ascensions | -| [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) | number | Total earned dexterity experience | -| [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) | number | Current dexterity experience | -| [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) | number | Dexterity multiplier from equipment | -| [dex](./bitburner.gangmemberinfo.dex.md) | number | Dexterity skill level | -| [earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) | number | | -| [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) | number | Hack multiplier from ascensions | -| [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) | number | Total earned hack experience | -| [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) | number | Current hack experience | -| [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) | number | Hack multiplier from equipment | -| [hack](./bitburner.gangmemberinfo.hack.md) | number | Hack skill level | -| [moneyGain](./bitburner.gangmemberinfo.moneygain.md) | number | | -| [name](./bitburner.gangmemberinfo.name.md) | string | Name of the gang member | -| [respectGain](./bitburner.gangmemberinfo.respectgain.md) | number | | -| [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) | number | Strength multiplier from ascensions | -| [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) | number | Total earned strength experience | -| [str\_exp](./bitburner.gangmemberinfo.str_exp.md) | number | Current strength experience | -| [str\_mult](./bitburner.gangmemberinfo.str_mult.md) | number | Strength multiplier from equipment | -| [str](./bitburner.gangmemberinfo.str.md) | number | Strength skill level | -| [task](./bitburner.gangmemberinfo.task.md) | string | Currently assigned task | -| [upgrades](./bitburner.gangmemberinfo.upgrades.md) | string\[\] | | -| [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) | | number | Agility multiplier from ascensions | +| [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) | | number | Total earned agility experience | +| [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) | | number | Current agility experience | +| [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) | | number | Agility multiplier from equipment | +| [agi](./bitburner.gangmemberinfo.agi.md) | | number | Agility skill level | +| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | | string\[\] | | +| [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) | | number | Charisma multiplier from ascensions | +| [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) | | number | Total earned charisma experience | +| [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) | | number | Current charisma experience | +| [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) | | number | Charisma multiplier from equipment | +| [cha](./bitburner.gangmemberinfo.cha.md) | | number | Charisma skill level | +| [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) | | number | Defense multiplier from ascensions | +| [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) | | number | Total earned defense experience | +| [def\_exp](./bitburner.gangmemberinfo.def_exp.md) | | number | Current defense experience | +| [def\_mult](./bitburner.gangmemberinfo.def_mult.md) | | number | Defense multiplier from equipment | +| [def](./bitburner.gangmemberinfo.def.md) | | number | Defense skill level | +| [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) | | number | Dexterity multiplier from ascensions | +| [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) | | number | Total earned dexterity experience | +| [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) | | number | Current dexterity experience | +| [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) | | number | Dexterity multiplier from equipment | +| [dex](./bitburner.gangmemberinfo.dex.md) | | number | Dexterity skill level | +| [earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) | | number | | +| [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) | | number | Hack multiplier from ascensions | +| [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) | | number | Total earned hack experience | +| [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) | | number | Current hack experience | +| [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) | | number | Hack multiplier from equipment | +| [hack](./bitburner.gangmemberinfo.hack.md) | | number | Hack skill level | +| [moneyGain](./bitburner.gangmemberinfo.moneygain.md) | | number | | +| [name](./bitburner.gangmemberinfo.name.md) | | string | Name of the gang member | +| [respectGain](./bitburner.gangmemberinfo.respectgain.md) | | number | | +| [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) | | number | Strength multiplier from ascensions | +| [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) | | number | Total earned strength experience | +| [str\_exp](./bitburner.gangmemberinfo.str_exp.md) | | number | Current strength experience | +| [str\_mult](./bitburner.gangmemberinfo.str_mult.md) | | number | Strength multiplier from equipment | +| [str](./bitburner.gangmemberinfo.str.md) | | number | Strength skill level | +| [task](./bitburner.gangmemberinfo.task.md) | | string | Currently assigned task | +| [upgrades](./bitburner.gangmemberinfo.upgrades.md) | | string\[\] | | +| [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) | | number | | diff --git a/markdown/bitburner.gangmemberinfo.moneygain.md b/markdown/bitburner.gangmemberinfo.moneygain.md index 98b42f676..1d33994e0 100644 --- a/markdown/bitburner.gangmemberinfo.moneygain.md +++ b/markdown/bitburner.gangmemberinfo.moneygain.md @@ -4,7 +4,7 @@ ## GangMemberInfo.moneyGain property -Signature: +**Signature:** ```typescript moneyGain: number; diff --git a/markdown/bitburner.gangmemberinfo.name.md b/markdown/bitburner.gangmemberinfo.name.md index f98233e8a..23610df46 100644 --- a/markdown/bitburner.gangmemberinfo.name.md +++ b/markdown/bitburner.gangmemberinfo.name.md @@ -6,7 +6,7 @@ Name of the gang member -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.gangmemberinfo.respectgain.md b/markdown/bitburner.gangmemberinfo.respectgain.md index 55654de17..0c778bbee 100644 --- a/markdown/bitburner.gangmemberinfo.respectgain.md +++ b/markdown/bitburner.gangmemberinfo.respectgain.md @@ -4,7 +4,7 @@ ## GangMemberInfo.respectGain property -Signature: +**Signature:** ```typescript respectGain: number; diff --git a/markdown/bitburner.gangmemberinfo.str.md b/markdown/bitburner.gangmemberinfo.str.md index ad8745274..bed661079 100644 --- a/markdown/bitburner.gangmemberinfo.str.md +++ b/markdown/bitburner.gangmemberinfo.str.md @@ -6,7 +6,7 @@ Strength skill level -Signature: +**Signature:** ```typescript str: number; diff --git a/markdown/bitburner.gangmemberinfo.str_asc_mult.md b/markdown/bitburner.gangmemberinfo.str_asc_mult.md index b0f512cac..329d98a28 100644 --- a/markdown/bitburner.gangmemberinfo.str_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.str_asc_mult.md @@ -6,7 +6,7 @@ Strength multiplier from ascensions -Signature: +**Signature:** ```typescript str_asc_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.str_asc_points.md b/markdown/bitburner.gangmemberinfo.str_asc_points.md index 9255896bf..935032e7d 100644 --- a/markdown/bitburner.gangmemberinfo.str_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.str_asc_points.md @@ -6,7 +6,7 @@ Total earned strength experience -Signature: +**Signature:** ```typescript str_asc_points: number; diff --git a/markdown/bitburner.gangmemberinfo.str_exp.md b/markdown/bitburner.gangmemberinfo.str_exp.md index 5d2480a94..0427dcab4 100644 --- a/markdown/bitburner.gangmemberinfo.str_exp.md +++ b/markdown/bitburner.gangmemberinfo.str_exp.md @@ -6,7 +6,7 @@ Current strength experience -Signature: +**Signature:** ```typescript str_exp: number; diff --git a/markdown/bitburner.gangmemberinfo.str_mult.md b/markdown/bitburner.gangmemberinfo.str_mult.md index dffeb8b13..5f54500e8 100644 --- a/markdown/bitburner.gangmemberinfo.str_mult.md +++ b/markdown/bitburner.gangmemberinfo.str_mult.md @@ -6,7 +6,7 @@ Strength multiplier from equipment -Signature: +**Signature:** ```typescript str_mult: number; diff --git a/markdown/bitburner.gangmemberinfo.task.md b/markdown/bitburner.gangmemberinfo.task.md index ff967194a..a929e493c 100644 --- a/markdown/bitburner.gangmemberinfo.task.md +++ b/markdown/bitburner.gangmemberinfo.task.md @@ -6,7 +6,7 @@ Currently assigned task -Signature: +**Signature:** ```typescript task: string; diff --git a/markdown/bitburner.gangmemberinfo.upgrades.md b/markdown/bitburner.gangmemberinfo.upgrades.md index c0296de6d..2b606d48b 100644 --- a/markdown/bitburner.gangmemberinfo.upgrades.md +++ b/markdown/bitburner.gangmemberinfo.upgrades.md @@ -4,7 +4,7 @@ ## GangMemberInfo.upgrades property -Signature: +**Signature:** ```typescript upgrades: string[]; diff --git a/markdown/bitburner.gangmemberinfo.wantedlevelgain.md b/markdown/bitburner.gangmemberinfo.wantedlevelgain.md index d259fa0dd..a52d4b5a7 100644 --- a/markdown/bitburner.gangmemberinfo.wantedlevelgain.md +++ b/markdown/bitburner.gangmemberinfo.wantedlevelgain.md @@ -4,7 +4,7 @@ ## GangMemberInfo.wantedLevelGain property -Signature: +**Signature:** ```typescript wantedLevelGain: number; diff --git a/markdown/bitburner.gangotherinfo.md b/markdown/bitburner.gangotherinfo.md index 9279a709c..7609298e1 100644 --- a/markdown/bitburner.gangotherinfo.md +++ b/markdown/bitburner.gangotherinfo.md @@ -5,7 +5,7 @@ ## GangOtherInfo interface -Signature: +**Signature:** ```typescript interface GangOtherInfo diff --git a/markdown/bitburner.gangotherinfoobject.md b/markdown/bitburner.gangotherinfoobject.md index 32c870ca1..9191e75a1 100644 --- a/markdown/bitburner.gangotherinfoobject.md +++ b/markdown/bitburner.gangotherinfoobject.md @@ -5,7 +5,7 @@ ## GangOtherInfoObject interface -Signature: +**Signature:** ```typescript interface GangOtherInfoObject @@ -13,8 +13,8 @@ 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 | +| Property | Modifiers | 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 index 58986c561..22b9fbc7a 100644 --- a/markdown/bitburner.gangotherinfoobject.power.md +++ b/markdown/bitburner.gangotherinfoobject.power.md @@ -6,7 +6,7 @@ Gang power -Signature: +**Signature:** ```typescript power: number; diff --git a/markdown/bitburner.gangotherinfoobject.territory.md b/markdown/bitburner.gangotherinfoobject.territory.md index 9314c4fc4..38a74f7f4 100644 --- a/markdown/bitburner.gangotherinfoobject.territory.md +++ b/markdown/bitburner.gangotherinfoobject.territory.md @@ -6,7 +6,7 @@ Gang territory, in decimal form -Signature: +**Signature:** ```typescript territory: number; diff --git a/markdown/bitburner.gangtaskstats.agiweight.md b/markdown/bitburner.gangtaskstats.agiweight.md index 422d3db6c..35afc11f6 100644 --- a/markdown/bitburner.gangtaskstats.agiweight.md +++ b/markdown/bitburner.gangtaskstats.agiweight.md @@ -6,7 +6,7 @@ Agility skill impact on task scaling -Signature: +**Signature:** ```typescript agiWeight: number; diff --git a/markdown/bitburner.gangtaskstats.basemoney.md b/markdown/bitburner.gangtaskstats.basemoney.md index 95e86a01a..be60d3ee3 100644 --- a/markdown/bitburner.gangtaskstats.basemoney.md +++ b/markdown/bitburner.gangtaskstats.basemoney.md @@ -6,7 +6,7 @@ Base money earned -Signature: +**Signature:** ```typescript baseMoney: number; diff --git a/markdown/bitburner.gangtaskstats.baserespect.md b/markdown/bitburner.gangtaskstats.baserespect.md index 4eebb322f..2620e4452 100644 --- a/markdown/bitburner.gangtaskstats.baserespect.md +++ b/markdown/bitburner.gangtaskstats.baserespect.md @@ -6,7 +6,7 @@ Base respect earned -Signature: +**Signature:** ```typescript baseRespect: number; diff --git a/markdown/bitburner.gangtaskstats.basewanted.md b/markdown/bitburner.gangtaskstats.basewanted.md index 789a2baf8..1af257b85 100644 --- a/markdown/bitburner.gangtaskstats.basewanted.md +++ b/markdown/bitburner.gangtaskstats.basewanted.md @@ -6,7 +6,7 @@ Base wanted earned -Signature: +**Signature:** ```typescript baseWanted: number; diff --git a/markdown/bitburner.gangtaskstats.chaweight.md b/markdown/bitburner.gangtaskstats.chaweight.md index 760e96a50..9ffcd8981 100644 --- a/markdown/bitburner.gangtaskstats.chaweight.md +++ b/markdown/bitburner.gangtaskstats.chaweight.md @@ -6,7 +6,7 @@ Charisma skill impact on task scaling -Signature: +**Signature:** ```typescript chaWeight: number; diff --git a/markdown/bitburner.gangtaskstats.defweight.md b/markdown/bitburner.gangtaskstats.defweight.md index ed2399bba..b99c27151 100644 --- a/markdown/bitburner.gangtaskstats.defweight.md +++ b/markdown/bitburner.gangtaskstats.defweight.md @@ -6,7 +6,7 @@ Defense skill impact on task scaling -Signature: +**Signature:** ```typescript defWeight: number; diff --git a/markdown/bitburner.gangtaskstats.desc.md b/markdown/bitburner.gangtaskstats.desc.md index 972036267..61a22daba 100644 --- a/markdown/bitburner.gangtaskstats.desc.md +++ b/markdown/bitburner.gangtaskstats.desc.md @@ -6,7 +6,7 @@ Task Description -Signature: +**Signature:** ```typescript desc: string; diff --git a/markdown/bitburner.gangtaskstats.dexweight.md b/markdown/bitburner.gangtaskstats.dexweight.md index 95eb529dd..ce1af2b21 100644 --- a/markdown/bitburner.gangtaskstats.dexweight.md +++ b/markdown/bitburner.gangtaskstats.dexweight.md @@ -6,7 +6,7 @@ Dexterity skill impact on task scaling -Signature: +**Signature:** ```typescript dexWeight: number; diff --git a/markdown/bitburner.gangtaskstats.difficulty.md b/markdown/bitburner.gangtaskstats.difficulty.md index ae6f83cca..5a7fd0ba8 100644 --- a/markdown/bitburner.gangtaskstats.difficulty.md +++ b/markdown/bitburner.gangtaskstats.difficulty.md @@ -6,7 +6,7 @@ Number representing the difficulty of the task -Signature: +**Signature:** ```typescript difficulty: number; diff --git a/markdown/bitburner.gangtaskstats.hackweight.md b/markdown/bitburner.gangtaskstats.hackweight.md index 2c1e81c26..999a42360 100644 --- a/markdown/bitburner.gangtaskstats.hackweight.md +++ b/markdown/bitburner.gangtaskstats.hackweight.md @@ -6,7 +6,7 @@ Hacking skill impact on task scaling -Signature: +**Signature:** ```typescript hackWeight: number; diff --git a/markdown/bitburner.gangtaskstats.iscombat.md b/markdown/bitburner.gangtaskstats.iscombat.md index b32351902..dc4654f68 100644 --- a/markdown/bitburner.gangtaskstats.iscombat.md +++ b/markdown/bitburner.gangtaskstats.iscombat.md @@ -6,7 +6,7 @@ Is a task of a combat gang -Signature: +**Signature:** ```typescript isCombat: boolean; diff --git a/markdown/bitburner.gangtaskstats.ishacking.md b/markdown/bitburner.gangtaskstats.ishacking.md index dcc183b74..edaf803e6 100644 --- a/markdown/bitburner.gangtaskstats.ishacking.md +++ b/markdown/bitburner.gangtaskstats.ishacking.md @@ -6,7 +6,7 @@ Is a task of a hacking gang -Signature: +**Signature:** ```typescript isHacking: boolean; diff --git a/markdown/bitburner.gangtaskstats.md b/markdown/bitburner.gangtaskstats.md index b1ce25db7..505443931 100644 --- a/markdown/bitburner.gangtaskstats.md +++ b/markdown/bitburner.gangtaskstats.md @@ -6,7 +6,7 @@ Object representing data representing a gang member task. -Signature: +**Signature:** ```typescript interface GangTaskStats @@ -14,21 +14,21 @@ interface GangTaskStats ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agiWeight](./bitburner.gangtaskstats.agiweight.md) | number | Agility skill impact on task scaling | -| [baseMoney](./bitburner.gangtaskstats.basemoney.md) | number | Base money earned | -| [baseRespect](./bitburner.gangtaskstats.baserespect.md) | number | Base respect earned | -| [baseWanted](./bitburner.gangtaskstats.basewanted.md) | number | Base wanted earned | -| [chaWeight](./bitburner.gangtaskstats.chaweight.md) | number | Charisma skill impact on task scaling | -| [defWeight](./bitburner.gangtaskstats.defweight.md) | number | Defense skill impact on task scaling | -| [desc](./bitburner.gangtaskstats.desc.md) | string | Task Description | -| [dexWeight](./bitburner.gangtaskstats.dexweight.md) | number | Dexterity skill impact on task scaling | -| [difficulty](./bitburner.gangtaskstats.difficulty.md) | number | Number representing the difficulty of the task | -| [hackWeight](./bitburner.gangtaskstats.hackweight.md) | number | Hacking skill impact on task scaling | -| [isCombat](./bitburner.gangtaskstats.iscombat.md) | boolean | Is a task of a combat gang | -| [isHacking](./bitburner.gangtaskstats.ishacking.md) | boolean | Is a task of a hacking gang | -| [name](./bitburner.gangtaskstats.name.md) | string | Task name | -| [strWeight](./bitburner.gangtaskstats.strweight.md) | number | Strength skill impact on task scaling | -| [territory](./bitburner.gangtaskstats.territory.md) | [GangTerritory](./bitburner.gangterritory.md) | Territory impact on task scaling | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agiWeight](./bitburner.gangtaskstats.agiweight.md) | | number | Agility skill impact on task scaling | +| [baseMoney](./bitburner.gangtaskstats.basemoney.md) | | number | Base money earned | +| [baseRespect](./bitburner.gangtaskstats.baserespect.md) | | number | Base respect earned | +| [baseWanted](./bitburner.gangtaskstats.basewanted.md) | | number | Base wanted earned | +| [chaWeight](./bitburner.gangtaskstats.chaweight.md) | | number | Charisma skill impact on task scaling | +| [defWeight](./bitburner.gangtaskstats.defweight.md) | | number | Defense skill impact on task scaling | +| [desc](./bitburner.gangtaskstats.desc.md) | | string | Task Description | +| [dexWeight](./bitburner.gangtaskstats.dexweight.md) | | number | Dexterity skill impact on task scaling | +| [difficulty](./bitburner.gangtaskstats.difficulty.md) | | number | Number representing the difficulty of the task | +| [hackWeight](./bitburner.gangtaskstats.hackweight.md) | | number | Hacking skill impact on task scaling | +| [isCombat](./bitburner.gangtaskstats.iscombat.md) | | boolean | Is a task of a combat gang | +| [isHacking](./bitburner.gangtaskstats.ishacking.md) | | boolean | Is a task of a hacking gang | +| [name](./bitburner.gangtaskstats.name.md) | | string | Task name | +| [strWeight](./bitburner.gangtaskstats.strweight.md) | | number | Strength skill impact on task scaling | +| [territory](./bitburner.gangtaskstats.territory.md) | | [GangTerritory](./bitburner.gangterritory.md) | Territory impact on task scaling | diff --git a/markdown/bitburner.gangtaskstats.name.md b/markdown/bitburner.gangtaskstats.name.md index 51cfbd6a5..1b76dcffe 100644 --- a/markdown/bitburner.gangtaskstats.name.md +++ b/markdown/bitburner.gangtaskstats.name.md @@ -6,7 +6,7 @@ Task name -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.gangtaskstats.strweight.md b/markdown/bitburner.gangtaskstats.strweight.md index 5c3b92f7f..5e943a6aa 100644 --- a/markdown/bitburner.gangtaskstats.strweight.md +++ b/markdown/bitburner.gangtaskstats.strweight.md @@ -6,7 +6,7 @@ Strength skill impact on task scaling -Signature: +**Signature:** ```typescript strWeight: number; diff --git a/markdown/bitburner.gangtaskstats.territory.md b/markdown/bitburner.gangtaskstats.territory.md index 65737c79f..f75ea7e1e 100644 --- a/markdown/bitburner.gangtaskstats.territory.md +++ b/markdown/bitburner.gangtaskstats.territory.md @@ -6,7 +6,7 @@ Territory impact on task scaling -Signature: +**Signature:** ```typescript territory: GangTerritory; diff --git a/markdown/bitburner.gangterritory.md b/markdown/bitburner.gangterritory.md index bacbdc449..1ef82b948 100644 --- a/markdown/bitburner.gangterritory.md +++ b/markdown/bitburner.gangterritory.md @@ -5,7 +5,7 @@ ## GangTerritory interface -Signature: +**Signature:** ```typescript interface GangTerritory @@ -13,9 +13,9 @@ interface GangTerritory ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [money](./bitburner.gangterritory.money.md) | number | Money gain impact on task scaling | -| [respect](./bitburner.gangterritory.respect.md) | number | Respect gain impact on task scaling | -| [wanted](./bitburner.gangterritory.wanted.md) | number | Wanted gain impact on task scaling | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [money](./bitburner.gangterritory.money.md) | | number | Money gain impact on task scaling | +| [respect](./bitburner.gangterritory.respect.md) | | number | Respect gain impact on task scaling | +| [wanted](./bitburner.gangterritory.wanted.md) | | number | Wanted gain impact on task scaling | diff --git a/markdown/bitburner.gangterritory.money.md b/markdown/bitburner.gangterritory.money.md index 9648f795f..faa389b54 100644 --- a/markdown/bitburner.gangterritory.money.md +++ b/markdown/bitburner.gangterritory.money.md @@ -6,7 +6,7 @@ Money gain impact on task scaling -Signature: +**Signature:** ```typescript money: number; diff --git a/markdown/bitburner.gangterritory.respect.md b/markdown/bitburner.gangterritory.respect.md index ebbe5fac6..84fb719cf 100644 --- a/markdown/bitburner.gangterritory.respect.md +++ b/markdown/bitburner.gangterritory.respect.md @@ -6,7 +6,7 @@ Respect gain impact on task scaling -Signature: +**Signature:** ```typescript respect: number; diff --git a/markdown/bitburner.gangterritory.wanted.md b/markdown/bitburner.gangterritory.wanted.md index 5e6c4f12e..5c5dc7cb5 100644 --- a/markdown/bitburner.gangterritory.wanted.md +++ b/markdown/bitburner.gangterritory.wanted.md @@ -6,7 +6,7 @@ Wanted gain impact on task scaling -Signature: +**Signature:** ```typescript wanted: number; diff --git a/markdown/bitburner.grafting.getaugmentationgraftprice.md b/markdown/bitburner.grafting.getaugmentationgraftprice.md index 1766e60d7..237a29a2b 100644 --- a/markdown/bitburner.grafting.getaugmentationgraftprice.md +++ b/markdown/bitburner.grafting.getaugmentationgraftprice.md @@ -6,7 +6,7 @@ Retrieve the grafting cost of an aug. -Signature: +**Signature:** ```typescript getAugmentationGraftPrice(augName: string): number; @@ -18,7 +18,7 @@ getAugmentationGraftPrice(augName: string): number; | --- | --- | --- | | augName | string | Name of the aug to check the price of. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.grafting.getaugmentationgrafttime.md b/markdown/bitburner.grafting.getaugmentationgrafttime.md index 2e4488d92..12f39dcb7 100644 --- a/markdown/bitburner.grafting.getaugmentationgrafttime.md +++ b/markdown/bitburner.grafting.getaugmentationgrafttime.md @@ -6,7 +6,7 @@ Retrieves the time required to graft an aug. -Signature: +**Signature:** ```typescript getAugmentationGraftTime(augName: string): number; @@ -18,7 +18,7 @@ getAugmentationGraftTime(augName: string): number; | --- | --- | --- | | augName | string | Name of the aug to check the grafting time of. Must be an exact match. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.grafting.getgraftableaugmentations.md b/markdown/bitburner.grafting.getgraftableaugmentations.md index 6bb0af8d9..b11713f13 100644 --- a/markdown/bitburner.grafting.getgraftableaugmentations.md +++ b/markdown/bitburner.grafting.getgraftableaugmentations.md @@ -6,12 +6,12 @@ Retrieves a list of Augmentations that can be grafted. -Signature: +**Signature:** ```typescript getGraftableAugmentations(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.grafting.graftaugmentation.md b/markdown/bitburner.grafting.graftaugmentation.md index 8d44d0185..2e203ae59 100644 --- a/markdown/bitburner.grafting.graftaugmentation.md +++ b/markdown/bitburner.grafting.graftaugmentation.md @@ -6,7 +6,7 @@ Begins grafting the named aug. You must be in New Tokyo to use this. -Signature: +**Signature:** ```typescript graftAugmentation(augName: string, focus?: boolean): boolean; @@ -17,9 +17,9 @@ graftAugmentation(augName: string, focus?: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | | augName | string | The name of the aug to begin grafting. Must be an exact match. | -| focus | boolean | Acquire player focus on this Augmentation grafting. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this Augmentation grafting. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.grafting.md b/markdown/bitburner.grafting.md index ddb90014c..af939323c 100644 --- a/markdown/bitburner.grafting.md +++ b/markdown/bitburner.grafting.md @@ -6,7 +6,7 @@ Grafting API -Signature: +**Signature:** ```typescript export interface Grafting diff --git a/markdown/bitburner.gymtype.md b/markdown/bitburner.gymtype.md index b340bbfa6..9ae1e45bf 100644 --- a/markdown/bitburner.gymtype.md +++ b/markdown/bitburner.gymtype.md @@ -5,7 +5,7 @@ ## GymType enum -Signature: +**Signature:** ```typescript declare enum GymType diff --git a/markdown/bitburner.hackingformulas.growpercent.md b/markdown/bitburner.hackingformulas.growpercent.md index 0f6cb7d7b..b25e3279e 100644 --- a/markdown/bitburner.hackingformulas.growpercent.md +++ b/markdown/bitburner.hackingformulas.growpercent.md @@ -6,7 +6,7 @@ Calculate the percent a server would grow to. Not exact due to limitations of mathematics. (Ex: 3.0 would would grow the server to 300% of its current value.) -Signature: +**Signature:** ```typescript growPercent(server: Server, threads: number, player: Person, cores?: number): number; @@ -19,9 +19,9 @@ growPercent(server: Server, threads: number, player: Person, cores?: number): nu | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | threads | number | Amount of thread. | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -| cores | number | Number of cores on the computer that will execute grow. | +| cores | number | _(Optional)_ Number of cores on the computer that will execute grow. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.growtime.md b/markdown/bitburner.hackingformulas.growtime.md index 20a393163..317dbc123 100644 --- a/markdown/bitburner.hackingformulas.growtime.md +++ b/markdown/bitburner.hackingformulas.growtime.md @@ -6,7 +6,7 @@ Calculate grow time. -Signature: +**Signature:** ```typescript growTime(server: Server, player: Person): number; @@ -19,7 +19,7 @@ growTime(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.hackchance.md b/markdown/bitburner.hackingformulas.hackchance.md index 3bae67598..0ef6007ad 100644 --- a/markdown/bitburner.hackingformulas.hackchance.md +++ b/markdown/bitburner.hackingformulas.hackchance.md @@ -6,7 +6,7 @@ Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) -Signature: +**Signature:** ```typescript hackChance(server: Server, player: Person): number; @@ -19,7 +19,7 @@ hackChance(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.hackexp.md b/markdown/bitburner.hackingformulas.hackexp.md index 998b7b600..27af1cc07 100644 --- a/markdown/bitburner.hackingformulas.hackexp.md +++ b/markdown/bitburner.hackingformulas.hackexp.md @@ -6,7 +6,7 @@ Calculate hack exp for one thread. -Signature: +**Signature:** ```typescript hackExp(server: Server, player: Person): number; @@ -19,7 +19,7 @@ hackExp(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.hackpercent.md b/markdown/bitburner.hackingformulas.hackpercent.md index 4c5f65e37..9f4f11dae 100644 --- a/markdown/bitburner.hackingformulas.hackpercent.md +++ b/markdown/bitburner.hackingformulas.hackpercent.md @@ -6,7 +6,7 @@ Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.) -Signature: +**Signature:** ```typescript hackPercent(server: Server, player: Person): number; @@ -19,7 +19,7 @@ hackPercent(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.hacktime.md b/markdown/bitburner.hackingformulas.hacktime.md index 7e6886437..a9c27b3ec 100644 --- a/markdown/bitburner.hackingformulas.hacktime.md +++ b/markdown/bitburner.hackingformulas.hacktime.md @@ -6,7 +6,7 @@ Calculate hack time. -Signature: +**Signature:** ```typescript hackTime(server: Server, player: Person): number; @@ -19,7 +19,7 @@ hackTime(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingformulas.md b/markdown/bitburner.hackingformulas.md index 638b2da80..4bcf892de 100644 --- a/markdown/bitburner.hackingformulas.md +++ b/markdown/bitburner.hackingformulas.md @@ -6,7 +6,7 @@ Hacking formulas -Signature: +**Signature:** ```typescript interface HackingFormulas diff --git a/markdown/bitburner.hackingformulas.weakentime.md b/markdown/bitburner.hackingformulas.weakentime.md index a166a3cd2..dfc0656d7 100644 --- a/markdown/bitburner.hackingformulas.weakentime.md +++ b/markdown/bitburner.hackingformulas.weakentime.md @@ -6,7 +6,7 @@ Calculate weaken time. -Signature: +**Signature:** ```typescript weakenTime(server: Server, player: Person): number; @@ -19,7 +19,7 @@ weakenTime(server: Server, player: Person): number; | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hackingmultipliers.chance.md b/markdown/bitburner.hackingmultipliers.chance.md index 9f7b5c2b5..3259d9ffc 100644 --- a/markdown/bitburner.hackingmultipliers.chance.md +++ b/markdown/bitburner.hackingmultipliers.chance.md @@ -6,7 +6,7 @@ Player's hacking chance multiplier. -Signature: +**Signature:** ```typescript chance: number; diff --git a/markdown/bitburner.hackingmultipliers.growth.md b/markdown/bitburner.hackingmultipliers.growth.md index 43ad29e2d..c3798e32e 100644 --- a/markdown/bitburner.hackingmultipliers.growth.md +++ b/markdown/bitburner.hackingmultipliers.growth.md @@ -6,7 +6,7 @@ Player's hacking growth multiplier -Signature: +**Signature:** ```typescript growth: number; diff --git a/markdown/bitburner.hackingmultipliers.md b/markdown/bitburner.hackingmultipliers.md index f9a9fec2d..52041b712 100644 --- a/markdown/bitburner.hackingmultipliers.md +++ b/markdown/bitburner.hackingmultipliers.md @@ -6,7 +6,7 @@ Hack related multipliers. -Signature: +**Signature:** ```typescript interface HackingMultipliers @@ -14,10 +14,10 @@ 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. | +| Property | Modifiers | 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 index e578aaa14..99811e151 100644 --- a/markdown/bitburner.hackingmultipliers.money.md +++ b/markdown/bitburner.hackingmultipliers.money.md @@ -6,7 +6,7 @@ Player's hacking money stolen multiplier. -Signature: +**Signature:** ```typescript money: number; diff --git a/markdown/bitburner.hackingmultipliers.speed.md b/markdown/bitburner.hackingmultipliers.speed.md index 646bec789..f59625335 100644 --- a/markdown/bitburner.hackingmultipliers.speed.md +++ b/markdown/bitburner.hackingmultipliers.speed.md @@ -6,7 +6,7 @@ Player's hacking speed multiplier. -Signature: +**Signature:** ```typescript speed: number; diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md index 6a9d5055c..101ad8e53 100644 --- a/markdown/bitburner.hacknet.getcacheupgradecost.md +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -6,7 +6,7 @@ Calculate the cost of upgrading hacknet node cache. -Signature: +**Signature:** ```typescript getCacheUpgradeCost(index: number, n: number): number; @@ -19,7 +19,7 @@ getCacheUpgradeCost(index: number, n: number): number; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of times to upgrade cache. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md index 47447d33c..6f34adad5 100644 --- a/markdown/bitburner.hacknet.getcoreupgradecost.md +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -6,7 +6,7 @@ Calculate the cost of upgrading hacknet node cores. -Signature: +**Signature:** ```typescript getCoreUpgradeCost(index: number, n: number): number; @@ -19,7 +19,7 @@ getCoreUpgradeCost(index: number, n: number): number; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of times to upgrade cores. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.gethashupgradelevel.md b/markdown/bitburner.hacknet.gethashupgradelevel.md index db2237ae2..8bf459d69 100644 --- a/markdown/bitburner.hacknet.gethashupgradelevel.md +++ b/markdown/bitburner.hacknet.gethashupgradelevel.md @@ -6,7 +6,7 @@ Get the level of a hash upgrade. -Signature: +**Signature:** ```typescript getHashUpgradeLevel(upgName: string): number; @@ -18,7 +18,7 @@ getHashUpgradeLevel(upgName: string): number; | --- | --- | --- | | upgName | string | | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.gethashupgrades.md b/markdown/bitburner.hacknet.gethashupgrades.md index b0ef78eb1..2f606b063 100644 --- a/markdown/bitburner.hacknet.gethashupgrades.md +++ b/markdown/bitburner.hacknet.gethashupgrades.md @@ -6,12 +6,12 @@ Get the list of hash upgrades -Signature: +**Signature:** ```typescript getHashUpgrades(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md index 13f8d07fa..8410bef52 100644 --- a/markdown/bitburner.hacknet.getlevelupgradecost.md +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -6,7 +6,7 @@ Calculate the cost of upgrading hacknet node levels. -Signature: +**Signature:** ```typescript getLevelUpgradeCost(index: number, n: number): number; @@ -19,7 +19,7 @@ getLevelUpgradeCost(index: number, n: number): number; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of levels to upgrade. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.getnodestats.md b/markdown/bitburner.hacknet.getnodestats.md index 117d9d41c..d804503b2 100644 --- a/markdown/bitburner.hacknet.getnodestats.md +++ b/markdown/bitburner.hacknet.getnodestats.md @@ -6,7 +6,7 @@ Get the stats of a hacknet node. -Signature: +**Signature:** ```typescript getNodeStats(index: number): NodeStats; @@ -18,7 +18,7 @@ getNodeStats(index: number): NodeStats; | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node | -Returns: +**Returns:** [NodeStats](./bitburner.nodestats.md) diff --git a/markdown/bitburner.hacknet.getpurchasenodecost.md b/markdown/bitburner.hacknet.getpurchasenodecost.md index a1d1908d1..5e8d2f787 100644 --- a/markdown/bitburner.hacknet.getpurchasenodecost.md +++ b/markdown/bitburner.hacknet.getpurchasenodecost.md @@ -6,12 +6,12 @@ Get the price of the next hacknet node. -Signature: +**Signature:** ```typescript getPurchaseNodeCost(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md index 7d449d345..a8c207316 100644 --- a/markdown/bitburner.hacknet.getramupgradecost.md +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -6,7 +6,7 @@ Calculate the cost of upgrading hacknet node RAM. -Signature: +**Signature:** ```typescript getRamUpgradeCost(index: number, n: number): number; @@ -19,7 +19,7 @@ getRamUpgradeCost(index: number, n: number): number; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.getstudymult.md b/markdown/bitburner.hacknet.getstudymult.md index 509dfe9a3..43bb89616 100644 --- a/markdown/bitburner.hacknet.getstudymult.md +++ b/markdown/bitburner.hacknet.getstudymult.md @@ -6,12 +6,12 @@ Get the multiplier to study. -Signature: +**Signature:** ```typescript getStudyMult(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.gettrainingmult.md b/markdown/bitburner.hacknet.gettrainingmult.md index 8f657f402..672b64361 100644 --- a/markdown/bitburner.hacknet.gettrainingmult.md +++ b/markdown/bitburner.hacknet.gettrainingmult.md @@ -6,12 +6,12 @@ Get the multiplier to training. -Signature: +**Signature:** ```typescript getTrainingMult(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.hashcapacity.md b/markdown/bitburner.hacknet.hashcapacity.md index 833a621f9..46144a9f6 100644 --- a/markdown/bitburner.hacknet.hashcapacity.md +++ b/markdown/bitburner.hacknet.hashcapacity.md @@ -6,12 +6,12 @@ Get the maximum number of hashes you can store. -Signature: +**Signature:** ```typescript hashCapacity(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.hashcost.md b/markdown/bitburner.hacknet.hashcost.md index fcf2de983..8668d5101 100644 --- a/markdown/bitburner.hacknet.hashcost.md +++ b/markdown/bitburner.hacknet.hashcost.md @@ -6,7 +6,7 @@ Get the cost of a hash upgrade. -Signature: +**Signature:** ```typescript hashCost(upgName: string, count?: number): number; @@ -17,9 +17,9 @@ hashCost(upgName: string, count?: number): number; | Parameter | Type | Description | | --- | --- | --- | | upgName | string | Name of the upgrade of Hacknet Node. | -| count | number | Number of upgrades to buy at once. Defaults to 1 if not specified. | +| count | number | _(Optional)_ Number of upgrades to buy at once. Defaults to 1 if not specified. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.maxnumnodes.md b/markdown/bitburner.hacknet.maxnumnodes.md index dfb249f5d..d0fa22280 100644 --- a/markdown/bitburner.hacknet.maxnumnodes.md +++ b/markdown/bitburner.hacknet.maxnumnodes.md @@ -6,12 +6,12 @@ Get the maximum number of hacknet nodes. -Signature: +**Signature:** ```typescript maxNumNodes(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md index ccff15191..f51f7c904 100644 --- a/markdown/bitburner.hacknet.md +++ b/markdown/bitburner.hacknet.md @@ -6,7 +6,7 @@ Hacknet API -Signature: +**Signature:** ```typescript export interface Hacknet diff --git a/markdown/bitburner.hacknet.numhashes.md b/markdown/bitburner.hacknet.numhashes.md index 9c20440b2..d698d0e6c 100644 --- a/markdown/bitburner.hacknet.numhashes.md +++ b/markdown/bitburner.hacknet.numhashes.md @@ -6,12 +6,12 @@ Get the total number of hashes stored. -Signature: +**Signature:** ```typescript numHashes(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.numnodes.md b/markdown/bitburner.hacknet.numnodes.md index 420f1d83a..fed9b5696 100644 --- a/markdown/bitburner.hacknet.numnodes.md +++ b/markdown/bitburner.hacknet.numnodes.md @@ -6,12 +6,12 @@ Get the number of hacknet nodes you own. -Signature: +**Signature:** ```typescript numNodes(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.purchasenode.md b/markdown/bitburner.hacknet.purchasenode.md index 762a8845e..c84dc9cf7 100644 --- a/markdown/bitburner.hacknet.purchasenode.md +++ b/markdown/bitburner.hacknet.purchasenode.md @@ -6,12 +6,12 @@ Purchase a new hacknet node. -Signature: +**Signature:** ```typescript purchaseNode(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md index c71f063a4..7842143aa 100644 --- a/markdown/bitburner.hacknet.spendhashes.md +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -6,7 +6,7 @@ Purchase a hash upgrade. -Signature: +**Signature:** ```typescript spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; @@ -17,10 +17,10 @@ spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | upgName | string | Name of the upgrade of Hacknet Node. | -| upgTarget | string | Object to which upgrade applies. Required for certain upgrades. | -| count | number | Number of upgrades to buy at once. Defaults to 1 if not specified. For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. | +| upgTarget | string | _(Optional)_ Object to which upgrade applies. Required for certain upgrades. | +| count | number | _(Optional)_ Number of upgrades to buy at once. Defaults to 1 if not specified. For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md index df6febe57..7a19e4028 100644 --- a/markdown/bitburner.hacknet.upgradecache.md +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -6,7 +6,7 @@ Upgrade the cache of a hacknet node. -Signature: +**Signature:** ```typescript upgradeCache(index: number, n: number): boolean; @@ -19,7 +19,7 @@ upgradeCache(index: number, n: number): boolean; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of cache levels to purchase. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md index cab7fe4bb..8f8e06c46 100644 --- a/markdown/bitburner.hacknet.upgradecore.md +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -6,7 +6,7 @@ Upgrade the core of a hacknet node. -Signature: +**Signature:** ```typescript upgradeCore(index: number, n: number): boolean; @@ -19,7 +19,7 @@ upgradeCore(index: number, n: number): boolean; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of cores to purchase. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md index fa286db87..a7b43cf75 100644 --- a/markdown/bitburner.hacknet.upgradelevel.md +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -6,7 +6,7 @@ Upgrade the level of a hacknet node. -Signature: +**Signature:** ```typescript upgradeLevel(index: number, n: number): boolean; @@ -19,7 +19,7 @@ upgradeLevel(index: number, n: number): boolean; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of levels to purchase. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md index c69dbcbe0..8fe15e2ea 100644 --- a/markdown/bitburner.hacknet.upgraderam.md +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -6,7 +6,7 @@ Upgrade the RAM of a hacknet node. -Signature: +**Signature:** ```typescript upgradeRam(index: number, n: number): boolean; @@ -19,7 +19,7 @@ upgradeRam(index: number, n: number): boolean; | index | number | Index/Identifier of Hacknet Node. | | n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.hacknetmultipliers.corecost.md b/markdown/bitburner.hacknetmultipliers.corecost.md index 2e9abb0dc..7bf382aae 100644 --- a/markdown/bitburner.hacknetmultipliers.corecost.md +++ b/markdown/bitburner.hacknetmultipliers.corecost.md @@ -6,7 +6,7 @@ Player's hacknet core cost multiplier -Signature: +**Signature:** ```typescript coreCost: number; diff --git a/markdown/bitburner.hacknetmultipliers.levelcost.md b/markdown/bitburner.hacknetmultipliers.levelcost.md index a09526c7e..a07febc83 100644 --- a/markdown/bitburner.hacknetmultipliers.levelcost.md +++ b/markdown/bitburner.hacknetmultipliers.levelcost.md @@ -6,7 +6,7 @@ Player's hacknet level cost multiplier -Signature: +**Signature:** ```typescript levelCost: number; diff --git a/markdown/bitburner.hacknetmultipliers.md b/markdown/bitburner.hacknetmultipliers.md index 6697e5eb6..e957cb8b9 100644 --- a/markdown/bitburner.hacknetmultipliers.md +++ b/markdown/bitburner.hacknetmultipliers.md @@ -6,7 +6,7 @@ Hacknet related multipliers. -Signature: +**Signature:** ```typescript interface HacknetMultipliers @@ -14,11 +14,11 @@ 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 | +| Property | Modifiers | 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 index 5b60f1d4a..dabde6908 100644 --- a/markdown/bitburner.hacknetmultipliers.production.md +++ b/markdown/bitburner.hacknetmultipliers.production.md @@ -6,7 +6,7 @@ Player's hacknet production multiplier -Signature: +**Signature:** ```typescript production: number; diff --git a/markdown/bitburner.hacknetmultipliers.purchasecost.md b/markdown/bitburner.hacknetmultipliers.purchasecost.md index 04a481172..f4e8760c2 100644 --- a/markdown/bitburner.hacknetmultipliers.purchasecost.md +++ b/markdown/bitburner.hacknetmultipliers.purchasecost.md @@ -6,7 +6,7 @@ Player's hacknet purchase cost multiplier -Signature: +**Signature:** ```typescript purchaseCost: number; diff --git a/markdown/bitburner.hacknetmultipliers.ramcost.md b/markdown/bitburner.hacknetmultipliers.ramcost.md index 94ac4a3c8..8605d0df3 100644 --- a/markdown/bitburner.hacknetmultipliers.ramcost.md +++ b/markdown/bitburner.hacknetmultipliers.ramcost.md @@ -6,7 +6,7 @@ Player's hacknet ram cost multiplier -Signature: +**Signature:** ```typescript ramCost: number; diff --git a/markdown/bitburner.hacknetnodeconstants.basecost.md b/markdown/bitburner.hacknetnodeconstants.basecost.md index 2f696b00c..d0fdaa0da 100644 --- a/markdown/bitburner.hacknetnodeconstants.basecost.md +++ b/markdown/bitburner.hacknetnodeconstants.basecost.md @@ -6,7 +6,7 @@ Base cost for a new node -Signature: +**Signature:** ```typescript BaseCost: number; diff --git a/markdown/bitburner.hacknetnodeconstants.corebasecost.md b/markdown/bitburner.hacknetnodeconstants.corebasecost.md index 23431d27d..feccc5c23 100644 --- a/markdown/bitburner.hacknetnodeconstants.corebasecost.md +++ b/markdown/bitburner.hacknetnodeconstants.corebasecost.md @@ -6,7 +6,7 @@ Base cost to increase cores -Signature: +**Signature:** ```typescript CoreBaseCost: number; diff --git a/markdown/bitburner.hacknetnodeconstants.levelbasecost.md b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md index 4bc92f2d7..5b5c63a4a 100644 --- a/markdown/bitburner.hacknetnodeconstants.levelbasecost.md +++ b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md @@ -6,7 +6,7 @@ Base cost per level -Signature: +**Signature:** ```typescript LevelBaseCost: number; diff --git a/markdown/bitburner.hacknetnodeconstants.maxcores.md b/markdown/bitburner.hacknetnodeconstants.maxcores.md index 4484421ac..b2ded052b 100644 --- a/markdown/bitburner.hacknetnodeconstants.maxcores.md +++ b/markdown/bitburner.hacknetnodeconstants.maxcores.md @@ -6,7 +6,7 @@ Max number of cores -Signature: +**Signature:** ```typescript MaxCores: number; diff --git a/markdown/bitburner.hacknetnodeconstants.maxlevel.md b/markdown/bitburner.hacknetnodeconstants.maxlevel.md index 87cf76ee8..67f5b69b4 100644 --- a/markdown/bitburner.hacknetnodeconstants.maxlevel.md +++ b/markdown/bitburner.hacknetnodeconstants.maxlevel.md @@ -6,7 +6,7 @@ Max node level -Signature: +**Signature:** ```typescript MaxLevel: number; diff --git a/markdown/bitburner.hacknetnodeconstants.maxram.md b/markdown/bitburner.hacknetnodeconstants.maxram.md index f3c6ee99e..f6266c9e3 100644 --- a/markdown/bitburner.hacknetnodeconstants.maxram.md +++ b/markdown/bitburner.hacknetnodeconstants.maxram.md @@ -6,7 +6,7 @@ Max amount of RAM in GB -Signature: +**Signature:** ```typescript MaxRam: number; diff --git a/markdown/bitburner.hacknetnodeconstants.md b/markdown/bitburner.hacknetnodeconstants.md index d70c40c57..99ea44864 100644 --- a/markdown/bitburner.hacknetnodeconstants.md +++ b/markdown/bitburner.hacknetnodeconstants.md @@ -6,7 +6,7 @@ Hacknet node related constants -Signature: +**Signature:** ```typescript interface HacknetNodeConstants @@ -14,18 +14,18 @@ interface HacknetNodeConstants ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) | number | Base cost for a new node | -| [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) | number | Base cost to increase cores | -| [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) | number | Base cost per level | -| [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) | number | Max number of cores | -| [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) | number | Max node level | -| [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | number | Max amount of RAM in GB | -| [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | number | Amount of money gained per level | -| [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | number | Multiplier to purchase new node | -| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | number | Base cost to increase RAM | -| [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | number | Multiplier to increase cores | -| [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | number | Multiplier to increase node level | -| [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | number | Multiplier to increase RAM | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) | | number | Base cost for a new node | +| [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) | | number | Base cost to increase cores | +| [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) | | number | Base cost per level | +| [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) | | number | Max number of cores | +| [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) | | number | Max node level | +| [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | | number | Max amount of RAM in GB | +| [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | | number | Amount of money gained per level | +| [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | | number | Multiplier to purchase new node | +| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | | number | Base cost to increase RAM | +| [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | | number | Multiplier to increase cores | +| [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | | number | Multiplier to increase node level | +| [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | | number | Multiplier to increase RAM | diff --git a/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md index 456437ca2..deeb7e4ec 100644 --- a/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md +++ b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md @@ -6,7 +6,7 @@ Amount of money gained per level -Signature: +**Signature:** ```typescript MoneyGainPerLevel: number; diff --git a/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md index fc9981f6a..10c419ed0 100644 --- a/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md +++ b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md @@ -6,7 +6,7 @@ Multiplier to purchase new node -Signature: +**Signature:** ```typescript PurchaseNextMult: number; diff --git a/markdown/bitburner.hacknetnodeconstants.rambasecost.md b/markdown/bitburner.hacknetnodeconstants.rambasecost.md index 41e3e4045..ec21bc0e8 100644 --- a/markdown/bitburner.hacknetnodeconstants.rambasecost.md +++ b/markdown/bitburner.hacknetnodeconstants.rambasecost.md @@ -6,7 +6,7 @@ Base cost to increase RAM -Signature: +**Signature:** ```typescript RamBaseCost: number; diff --git a/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md index 4ddd2bbc2..17bbc6abf 100644 --- a/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md +++ b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md @@ -6,7 +6,7 @@ Multiplier to increase cores -Signature: +**Signature:** ```typescript UpgradeCoreMult: number; diff --git a/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md index daa8553c4..c21cea64c 100644 --- a/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md +++ b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md @@ -6,7 +6,7 @@ Multiplier to increase node level -Signature: +**Signature:** ```typescript UpgradeLevelMult: number; diff --git a/markdown/bitburner.hacknetnodeconstants.upgraderammult.md b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md index 899902b70..d959ed744 100644 --- a/markdown/bitburner.hacknetnodeconstants.upgraderammult.md +++ b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md @@ -6,7 +6,7 @@ Multiplier to increase RAM -Signature: +**Signature:** ```typescript UpgradeRamMult: number; diff --git a/markdown/bitburner.hacknetnodesformulas.constants.md b/markdown/bitburner.hacknetnodesformulas.constants.md index 455463122..5ffde21e3 100644 --- a/markdown/bitburner.hacknetnodesformulas.constants.md +++ b/markdown/bitburner.hacknetnodesformulas.constants.md @@ -6,12 +6,12 @@ All constants used by the game. -Signature: +**Signature:** ```typescript constants(): HacknetNodeConstants; ``` -Returns: +**Returns:** [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) diff --git a/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md index 3217b4cb7..bcc3ae9cd 100644 --- a/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet node cores. -Signature: +**Signature:** ```typescript coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; @@ -17,10 +17,10 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n | Parameter | Type | Description | | --- | --- | --- | | startingCore | number | starting cores | -| extraCores | number | amount of cores to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraCores | number | _(Optional)_ amount of cores to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md index 7d88ecf86..afc300d85 100644 --- a/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md +++ b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md @@ -6,7 +6,7 @@ Calculate the cost of a hacknet node. -Signature: +**Signature:** ```typescript hacknetNodeCost(n: number, mult: number): number; @@ -19,7 +19,7 @@ hacknetNodeCost(n: number, mult: number): number; | n | number | number of the hacknet node | | mult | number | player cost reduction (defaults to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md index 53ac8090c..0852a0c40 100644 --- a/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet node level. -Signature: +**Signature:** ```typescript levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; @@ -17,10 +17,10 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number) | Parameter | Type | Description | | --- | --- | --- | | startingLevel | number | starting level | -| extraLevels | number | amount of level to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraLevels | number | _(Optional)_ amount of level to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetnodesformulas.md b/markdown/bitburner.hacknetnodesformulas.md index 90f7bc4ee..5c78af790 100644 --- a/markdown/bitburner.hacknetnodesformulas.md +++ b/markdown/bitburner.hacknetnodesformulas.md @@ -6,7 +6,7 @@ Hacknet Node formulas -Signature: +**Signature:** ```typescript interface HacknetNodesFormulas diff --git a/markdown/bitburner.hacknetnodesformulas.moneygainrate.md b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md index deb51878f..60cc16ccc 100644 --- a/markdown/bitburner.hacknetnodesformulas.moneygainrate.md +++ b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md @@ -6,7 +6,7 @@ Calculate money gain rate. -Signature: +**Signature:** ```typescript moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; @@ -19,9 +19,9 @@ moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; | level | number | level of the node. | | ram | number | ram of the node. | | cores | number | cores of the node. | -| mult | number | player production mult (default to 1) | +| mult | number | _(Optional)_ player production mult (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md index 6be6a5c01..e343061aa 100644 --- a/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet node ram. -Signature: +**Signature:** ```typescript ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; @@ -17,10 +17,10 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu | Parameter | Type | Description | | --- | --- | --- | | startingRam | number | starting ram | -| extraLevels | number | amount of level of ram to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraLevels | number | _(Optional)_ amount of level of ram to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserverconstants.basecost.md b/markdown/bitburner.hacknetserverconstants.basecost.md index ea787cddc..fcbd31917 100644 --- a/markdown/bitburner.hacknetserverconstants.basecost.md +++ b/markdown/bitburner.hacknetserverconstants.basecost.md @@ -6,7 +6,7 @@ Base cost for a new server -Signature: +**Signature:** ```typescript BaseCost: number; diff --git a/markdown/bitburner.hacknetserverconstants.cachebasecost.md b/markdown/bitburner.hacknetserverconstants.cachebasecost.md index d532f156d..442be3ec7 100644 --- a/markdown/bitburner.hacknetserverconstants.cachebasecost.md +++ b/markdown/bitburner.hacknetserverconstants.cachebasecost.md @@ -6,7 +6,7 @@ Base cost to upgrade cache -Signature: +**Signature:** ```typescript CacheBaseCost: number; diff --git a/markdown/bitburner.hacknetserverconstants.corebasecost.md b/markdown/bitburner.hacknetserverconstants.corebasecost.md index 856c37f59..fc8e79d20 100644 --- a/markdown/bitburner.hacknetserverconstants.corebasecost.md +++ b/markdown/bitburner.hacknetserverconstants.corebasecost.md @@ -6,7 +6,7 @@ Base cost to increase cores -Signature: +**Signature:** ```typescript CoreBaseCost: number; diff --git a/markdown/bitburner.hacknetserverconstants.hashesperlevel.md b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md index 4c0a296e2..06085cdcd 100644 --- a/markdown/bitburner.hacknetserverconstants.hashesperlevel.md +++ b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md @@ -6,7 +6,7 @@ Number of hashes calculated per level -Signature: +**Signature:** ```typescript HashesPerLevel: number; diff --git a/markdown/bitburner.hacknetserverconstants.maxcache.md b/markdown/bitburner.hacknetserverconstants.maxcache.md index b5beb72a2..22c7961da 100644 --- a/markdown/bitburner.hacknetserverconstants.maxcache.md +++ b/markdown/bitburner.hacknetserverconstants.maxcache.md @@ -6,7 +6,7 @@ Max cache size -Signature: +**Signature:** ```typescript MaxCache: number; diff --git a/markdown/bitburner.hacknetserverconstants.maxcores.md b/markdown/bitburner.hacknetserverconstants.maxcores.md index eecad52ca..bf2971e9c 100644 --- a/markdown/bitburner.hacknetserverconstants.maxcores.md +++ b/markdown/bitburner.hacknetserverconstants.maxcores.md @@ -6,7 +6,7 @@ Max number of cores -Signature: +**Signature:** ```typescript MaxCores: number; diff --git a/markdown/bitburner.hacknetserverconstants.maxlevel.md b/markdown/bitburner.hacknetserverconstants.maxlevel.md index 20a1d3167..a5548a942 100644 --- a/markdown/bitburner.hacknetserverconstants.maxlevel.md +++ b/markdown/bitburner.hacknetserverconstants.maxlevel.md @@ -6,7 +6,7 @@ Max level for a server -Signature: +**Signature:** ```typescript MaxLevel: number; diff --git a/markdown/bitburner.hacknetserverconstants.maxram.md b/markdown/bitburner.hacknetserverconstants.maxram.md index d67e2bb32..f39bce710 100644 --- a/markdown/bitburner.hacknetserverconstants.maxram.md +++ b/markdown/bitburner.hacknetserverconstants.maxram.md @@ -6,7 +6,7 @@ Max amount of RAM in GB -Signature: +**Signature:** ```typescript MaxRam: number; diff --git a/markdown/bitburner.hacknetserverconstants.maxservers.md b/markdown/bitburner.hacknetserverconstants.maxservers.md index d4808ddf9..b2f71ce4f 100644 --- a/markdown/bitburner.hacknetserverconstants.maxservers.md +++ b/markdown/bitburner.hacknetserverconstants.maxservers.md @@ -6,7 +6,7 @@ Max number of servers -Signature: +**Signature:** ```typescript MaxServers: number; diff --git a/markdown/bitburner.hacknetserverconstants.md b/markdown/bitburner.hacknetserverconstants.md index 01ddd2959..4c1e87013 100644 --- a/markdown/bitburner.hacknetserverconstants.md +++ b/markdown/bitburner.hacknetserverconstants.md @@ -6,7 +6,7 @@ Hacknet server related constants -Signature: +**Signature:** ```typescript interface HacknetServerConstants @@ -14,21 +14,21 @@ interface HacknetServerConstants ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [BaseCost](./bitburner.hacknetserverconstants.basecost.md) | number | Base cost for a new server | -| [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) | number | Base cost to upgrade cache | -| [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) | number | Base cost to increase cores | -| [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) | number | Number of hashes calculated per level | -| [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) | number | Max cache size | -| [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) | number | Max number of cores | -| [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) | number | Max level for a server | -| [MaxRam](./bitburner.hacknetserverconstants.maxram.md) | number | Max amount of RAM in GB | -| [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) | number | Max number of servers | -| [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) | number | Multiplier to purchase a new server | -| [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) | number | Base cost to increase RAM | -| [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) | number | Multiplier to upgrade cache | -| [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) | number | Multiplier to increase cores | -| [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) | number | Multiplier to increase server level | -| [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) | number | Multiplier to increase RAM | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [BaseCost](./bitburner.hacknetserverconstants.basecost.md) | | number | Base cost for a new server | +| [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) | | number | Base cost to upgrade cache | +| [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) | | number | Base cost to increase cores | +| [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) | | number | Number of hashes calculated per level | +| [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) | | number | Max cache size | +| [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) | | number | Max number of cores | +| [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) | | number | Max level for a server | +| [MaxRam](./bitburner.hacknetserverconstants.maxram.md) | | number | Max amount of RAM in GB | +| [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) | | number | Max number of servers | +| [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) | | number | Multiplier to purchase a new server | +| [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) | | number | Base cost to increase RAM | +| [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) | | number | Multiplier to upgrade cache | +| [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) | | number | Multiplier to increase cores | +| [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) | | number | Multiplier to increase server level | +| [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) | | number | Multiplier to increase RAM | diff --git a/markdown/bitburner.hacknetserverconstants.purchasemult.md b/markdown/bitburner.hacknetserverconstants.purchasemult.md index 32eef9e8a..3bf3d1912 100644 --- a/markdown/bitburner.hacknetserverconstants.purchasemult.md +++ b/markdown/bitburner.hacknetserverconstants.purchasemult.md @@ -6,7 +6,7 @@ Multiplier to purchase a new server -Signature: +**Signature:** ```typescript PurchaseMult: number; diff --git a/markdown/bitburner.hacknetserverconstants.rambasecost.md b/markdown/bitburner.hacknetserverconstants.rambasecost.md index 365a154ae..5f8008c01 100644 --- a/markdown/bitburner.hacknetserverconstants.rambasecost.md +++ b/markdown/bitburner.hacknetserverconstants.rambasecost.md @@ -6,7 +6,7 @@ Base cost to increase RAM -Signature: +**Signature:** ```typescript RamBaseCost: number; diff --git a/markdown/bitburner.hacknetserverconstants.upgradecachemult.md b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md index 7fdfe9eb0..5d72eb649 100644 --- a/markdown/bitburner.hacknetserverconstants.upgradecachemult.md +++ b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md @@ -6,7 +6,7 @@ Multiplier to upgrade cache -Signature: +**Signature:** ```typescript UpgradeCacheMult: number; diff --git a/markdown/bitburner.hacknetserverconstants.upgradecoremult.md b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md index 2c6541d46..954b0d51c 100644 --- a/markdown/bitburner.hacknetserverconstants.upgradecoremult.md +++ b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md @@ -6,7 +6,7 @@ Multiplier to increase cores -Signature: +**Signature:** ```typescript UpgradeCoreMult: number; diff --git a/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md index 81a67ecff..375bab319 100644 --- a/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md +++ b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md @@ -6,7 +6,7 @@ Multiplier to increase server level -Signature: +**Signature:** ```typescript UpgradeLevelMult: number; diff --git a/markdown/bitburner.hacknetserverconstants.upgraderammult.md b/markdown/bitburner.hacknetserverconstants.upgraderammult.md index 5273537c3..77372d531 100644 --- a/markdown/bitburner.hacknetserverconstants.upgraderammult.md +++ b/markdown/bitburner.hacknetserverconstants.upgraderammult.md @@ -6,7 +6,7 @@ Multiplier to increase RAM -Signature: +**Signature:** ```typescript UpgradeRamMult: number; diff --git a/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md index cf7a00710..096d32142 100644 --- a/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet server cache. -Signature: +**Signature:** ```typescript cacheUpgradeCost(startingCache: number, extraCache?: number): number; @@ -17,9 +17,9 @@ cacheUpgradeCost(startingCache: number, extraCache?: number): number; | Parameter | Type | Description | | --- | --- | --- | | startingCache | number | starting cache level | -| extraCache | number | amount of levels of cache to purchase (defaults to 1) | +| extraCache | number | _(Optional)_ amount of levels of cache to purchase (defaults to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.constants.md b/markdown/bitburner.hacknetserversformulas.constants.md index e17c88b5a..752415c7c 100644 --- a/markdown/bitburner.hacknetserversformulas.constants.md +++ b/markdown/bitburner.hacknetserversformulas.constants.md @@ -6,12 +6,12 @@ All constants used by the game. -Signature: +**Signature:** ```typescript constants(): HacknetServerConstants; ``` -Returns: +**Returns:** [HacknetServerConstants](./bitburner.hacknetserverconstants.md) diff --git a/markdown/bitburner.hacknetserversformulas.coreupgradecost.md b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md index 82bcc923d..66b32bb52 100644 --- a/markdown/bitburner.hacknetserversformulas.coreupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet server cores. -Signature: +**Signature:** ```typescript coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; @@ -17,10 +17,10 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n | Parameter | Type | Description | | --- | --- | --- | | startingCore | number | starting cores | -| extraCores | number | amount of cores to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraCores | number | _(Optional)_ amount of cores to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.hacknetservercost.md b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md index 55f7fd29a..cd4d436f4 100644 --- a/markdown/bitburner.hacknetserversformulas.hacknetservercost.md +++ b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md @@ -6,7 +6,7 @@ Calculate the cost of a hacknet server. -Signature: +**Signature:** ```typescript hacknetServerCost(n: number, mult?: number): number; @@ -17,9 +17,9 @@ hacknetServerCost(n: number, mult?: number): number; | Parameter | Type | Description | | --- | --- | --- | | n | number | number of the hacknet server | -| mult | number | player cost reduction (defaults to 1) | +| mult | number | _(Optional)_ player cost reduction (defaults to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.hashgainrate.md b/markdown/bitburner.hacknetserversformulas.hashgainrate.md index 51c960448..5ea1e8c7c 100644 --- a/markdown/bitburner.hacknetserversformulas.hashgainrate.md +++ b/markdown/bitburner.hacknetserversformulas.hashgainrate.md @@ -6,7 +6,7 @@ Calculate hash gain rate. -Signature: +**Signature:** ```typescript hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number; @@ -20,9 +20,9 @@ hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult | ramUsed | number | ramUsed of the server. | | maxRam | number | maxRam of the server. | | cores | number | cores of the server. | -| mult | number | player production mult (default to 1) | +| mult | number | _(Optional)_ player production mult (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.hashupgradecost.md b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md index 0cc4ec42b..7431ce569 100644 --- a/markdown/bitburner.hacknetserversformulas.hashupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md @@ -6,7 +6,7 @@ Calculate hash cost of an upgrade. -Signature: +**Signature:** ```typescript hashUpgradeCost(upgName: number, level: number): number; @@ -19,7 +19,7 @@ hashUpgradeCost(upgName: number, level: number): number; | upgName | number | name of the upgrade | | level | number | level of the upgrade | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.levelupgradecost.md b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md index de10d2a62..d679643c4 100644 --- a/markdown/bitburner.hacknetserversformulas.levelupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet server level. -Signature: +**Signature:** ```typescript levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; @@ -17,10 +17,10 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number) | Parameter | Type | Description | | --- | --- | --- | | startingLevel | number | starting level | -| extraLevels | number | amount of level to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraLevels | number | _(Optional)_ amount of level to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hacknetserversformulas.md b/markdown/bitburner.hacknetserversformulas.md index 059e4ba39..3ccee0895 100644 --- a/markdown/bitburner.hacknetserversformulas.md +++ b/markdown/bitburner.hacknetserversformulas.md @@ -6,7 +6,7 @@ Hacknet Server formulas -Signature: +**Signature:** ```typescript interface HacknetServersFormulas diff --git a/markdown/bitburner.hacknetserversformulas.ramupgradecost.md b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md index 1cd2c4b43..70f688b8a 100644 --- a/markdown/bitburner.hacknetserversformulas.ramupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md @@ -6,7 +6,7 @@ Calculate cost of upgrading hacknet server ram. -Signature: +**Signature:** ```typescript ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; @@ -17,10 +17,10 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu | Parameter | Type | Description | | --- | --- | --- | | startingRam | number | starting ram | -| extraLevels | number | amount of level of ram to purchase (defaults to 1) | -| costMult | number | player cost reduction (default to 1) | +| extraLevels | number | _(Optional)_ amount of level of ram to purchase (defaults to 1) | +| costMult | number | _(Optional)_ player cost reduction (default to 1) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.hp.current.md b/markdown/bitburner.hp.current.md index cebd3cbc7..26032ea7f 100644 --- a/markdown/bitburner.hp.current.md +++ b/markdown/bitburner.hp.current.md @@ -4,7 +4,7 @@ ## HP.current property -Signature: +**Signature:** ```typescript current: number; diff --git a/markdown/bitburner.hp.max.md b/markdown/bitburner.hp.max.md index e0a023eb6..16b1c1a6e 100644 --- a/markdown/bitburner.hp.max.md +++ b/markdown/bitburner.hp.max.md @@ -4,7 +4,7 @@ ## HP.max property -Signature: +**Signature:** ```typescript max: number; diff --git a/markdown/bitburner.hp.md b/markdown/bitburner.hp.md index 69c2ae850..7fe3d2ce5 100644 --- a/markdown/bitburner.hp.md +++ b/markdown/bitburner.hp.md @@ -5,7 +5,7 @@ ## HP interface -Signature: +**Signature:** ```typescript interface HP @@ -13,8 +13,8 @@ interface HP ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [current](./bitburner.hp.current.md) | number | | -| [max](./bitburner.hp.max.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [current](./bitburner.hp.current.md) | | number | | +| [max](./bitburner.hp.max.md) | | number | | diff --git a/markdown/bitburner.ilocation.city.md b/markdown/bitburner.ilocation.city.md index dfe1d9be2..48b525ef6 100644 --- a/markdown/bitburner.ilocation.city.md +++ b/markdown/bitburner.ilocation.city.md @@ -4,7 +4,7 @@ ## ILocation.city property -Signature: +**Signature:** ```typescript city: CityName; diff --git a/markdown/bitburner.ilocation.md b/markdown/bitburner.ilocation.md index e47b75a61..adb667c36 100644 --- a/markdown/bitburner.ilocation.md +++ b/markdown/bitburner.ilocation.md @@ -5,7 +5,7 @@ ## ILocation interface -Signature: +**Signature:** ```typescript interface ILocation @@ -13,8 +13,8 @@ interface ILocation ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [city](./bitburner.ilocation.city.md) | [CityName](./bitburner.cityname.md) | | -| [name](./bitburner.ilocation.name.md) | [LocationName](./bitburner.locationname.md) | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [city](./bitburner.ilocation.city.md) | | [CityName](./bitburner.cityname.md) | | +| [name](./bitburner.ilocation.name.md) | | [LocationName](./bitburner.locationname.md) | | diff --git a/markdown/bitburner.ilocation.name.md b/markdown/bitburner.ilocation.name.md index 9a7f08feb..e2d35036f 100644 --- a/markdown/bitburner.ilocation.name.md +++ b/markdown/bitburner.ilocation.name.md @@ -4,7 +4,7 @@ ## ILocation.name property -Signature: +**Signature:** ```typescript name: LocationName; diff --git a/markdown/bitburner.industrydata.cost.md b/markdown/bitburner.industrydata.cost.md index b41589a35..206b08947 100644 --- a/markdown/bitburner.industrydata.cost.md +++ b/markdown/bitburner.industrydata.cost.md @@ -6,7 +6,7 @@ Cost to expand to the division -Signature: +**Signature:** ```typescript cost: number; diff --git a/markdown/bitburner.industrydata.makesmaterials.md b/markdown/bitburner.industrydata.makesmaterials.md index db197a528..bcba6749e 100644 --- a/markdown/bitburner.industrydata.makesmaterials.md +++ b/markdown/bitburner.industrydata.makesmaterials.md @@ -6,7 +6,7 @@ Whether the division makes materials -Signature: +**Signature:** ```typescript makesMaterials: boolean; diff --git a/markdown/bitburner.industrydata.makesproducts.md b/markdown/bitburner.industrydata.makesproducts.md index 274118953..96e353482 100644 --- a/markdown/bitburner.industrydata.makesproducts.md +++ b/markdown/bitburner.industrydata.makesproducts.md @@ -6,7 +6,7 @@ Whether the division makes products -Signature: +**Signature:** ```typescript makesProducts: boolean; diff --git a/markdown/bitburner.industrydata.md b/markdown/bitburner.industrydata.md index 877ae4b24..d6046cc65 100644 --- a/markdown/bitburner.industrydata.md +++ b/markdown/bitburner.industrydata.md @@ -6,7 +6,7 @@ Corporation industry information -Signature: +**Signature:** ```typescript interface IndustryData @@ -14,13 +14,13 @@ interface IndustryData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cost](./bitburner.industrydata.cost.md) | number | Cost to expand to the division | -| [makesMaterials](./bitburner.industrydata.makesmaterials.md) | boolean | Whether the division makes materials | -| [makesProducts](./bitburner.industrydata.makesproducts.md) | boolean | Whether the division makes products | -| [producedMaterials?](./bitburner.industrydata.producedmaterials.md) | string\[\] | (Optional) Materials produced | -| [productType?](./bitburner.industrydata.producttype.md) | string | (Optional) Product type | -| [requiredMaterials](./bitburner.industrydata.requiredmaterials.md) | Record<string, number> | Materials required for production and their amounts | -| [type](./bitburner.industrydata.type.md) | [CorpIndustryName](./bitburner.corpindustryname.md) | Industry type | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cost](./bitburner.industrydata.cost.md) | | number | Cost to expand to the division | +| [makesMaterials](./bitburner.industrydata.makesmaterials.md) | | boolean | Whether the division makes materials | +| [makesProducts](./bitburner.industrydata.makesproducts.md) | | boolean | Whether the division makes products | +| [producedMaterials?](./bitburner.industrydata.producedmaterials.md) | | string\[\] | _(Optional)_ Materials produced | +| [productType?](./bitburner.industrydata.producttype.md) | | string | _(Optional)_ Product type | +| [requiredMaterials](./bitburner.industrydata.requiredmaterials.md) | | Record<string, number> | Materials required for production and their amounts | +| [type](./bitburner.industrydata.type.md) | | [CorpIndustryName](./bitburner.corpindustryname.md) | Industry type | diff --git a/markdown/bitburner.industrydata.producedmaterials.md b/markdown/bitburner.industrydata.producedmaterials.md index 80feafb86..2ed0ee441 100644 --- a/markdown/bitburner.industrydata.producedmaterials.md +++ b/markdown/bitburner.industrydata.producedmaterials.md @@ -6,7 +6,7 @@ Materials produced -Signature: +**Signature:** ```typescript producedMaterials?: string[]; diff --git a/markdown/bitburner.industrydata.producttype.md b/markdown/bitburner.industrydata.producttype.md index 369fe80e1..c6b7c5383 100644 --- a/markdown/bitburner.industrydata.producttype.md +++ b/markdown/bitburner.industrydata.producttype.md @@ -6,7 +6,7 @@ Product type -Signature: +**Signature:** ```typescript productType?: string; diff --git a/markdown/bitburner.industrydata.requiredmaterials.md b/markdown/bitburner.industrydata.requiredmaterials.md index 6839e49d7..01c9334b7 100644 --- a/markdown/bitburner.industrydata.requiredmaterials.md +++ b/markdown/bitburner.industrydata.requiredmaterials.md @@ -6,7 +6,7 @@ Materials required for production and their amounts -Signature: +**Signature:** ```typescript requiredMaterials: Record; diff --git a/markdown/bitburner.industrydata.type.md b/markdown/bitburner.industrydata.type.md index 0c4ff151d..047e7185e 100644 --- a/markdown/bitburner.industrydata.type.md +++ b/markdown/bitburner.industrydata.type.md @@ -6,7 +6,7 @@ Industry type -Signature: +**Signature:** ```typescript type: CorpIndustryName; diff --git a/markdown/bitburner.infiltration.getinfiltration.md b/markdown/bitburner.infiltration.getinfiltration.md index 7dc5c5cf4..a553290bd 100644 --- a/markdown/bitburner.infiltration.getinfiltration.md +++ b/markdown/bitburner.infiltration.getinfiltration.md @@ -6,7 +6,7 @@ Get all infiltrations with difficulty, location and rewards. -Signature: +**Signature:** ```typescript getInfiltration(location: string): InfiltrationLocation; @@ -18,7 +18,7 @@ getInfiltration(location: string): InfiltrationLocation; | --- | --- | --- | | location | string | | -Returns: +**Returns:** [InfiltrationLocation](./bitburner.infiltrationlocation.md) diff --git a/markdown/bitburner.infiltration.getpossiblelocations.md b/markdown/bitburner.infiltration.getpossiblelocations.md index d2a78e55f..67b90929e 100644 --- a/markdown/bitburner.infiltration.getpossiblelocations.md +++ b/markdown/bitburner.infiltration.getpossiblelocations.md @@ -6,12 +6,12 @@ Get all locations that can be infiltrated. -Signature: +**Signature:** ```typescript getPossibleLocations(): ILocation[]; ``` -Returns: +**Returns:** [ILocation](./bitburner.ilocation.md)\[\] diff --git a/markdown/bitburner.infiltration.md b/markdown/bitburner.infiltration.md index cfcd284ac..673bb335b 100644 --- a/markdown/bitburner.infiltration.md +++ b/markdown/bitburner.infiltration.md @@ -6,7 +6,7 @@ Infiltration API. -Signature: +**Signature:** ```typescript interface Infiltration diff --git a/markdown/bitburner.infiltrationlocation.difficulty.md b/markdown/bitburner.infiltrationlocation.difficulty.md index 849f0cbe7..a44a20f05 100644 --- a/markdown/bitburner.infiltrationlocation.difficulty.md +++ b/markdown/bitburner.infiltrationlocation.difficulty.md @@ -4,7 +4,7 @@ ## InfiltrationLocation.difficulty property -Signature: +**Signature:** ```typescript difficulty: number; diff --git a/markdown/bitburner.infiltrationlocation.location.md b/markdown/bitburner.infiltrationlocation.location.md index d884e5c99..90881a25c 100644 --- a/markdown/bitburner.infiltrationlocation.location.md +++ b/markdown/bitburner.infiltrationlocation.location.md @@ -4,7 +4,7 @@ ## InfiltrationLocation.location property -Signature: +**Signature:** ```typescript location: ILocation; diff --git a/markdown/bitburner.infiltrationlocation.md b/markdown/bitburner.infiltrationlocation.md index edb6f071f..519e0368c 100644 --- a/markdown/bitburner.infiltrationlocation.md +++ b/markdown/bitburner.infiltrationlocation.md @@ -5,7 +5,7 @@ ## InfiltrationLocation interface -Signature: +**Signature:** ```typescript interface InfiltrationLocation @@ -13,9 +13,9 @@ interface InfiltrationLocation ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [difficulty](./bitburner.infiltrationlocation.difficulty.md) | number | | -| [location](./bitburner.infiltrationlocation.location.md) | [ILocation](./bitburner.ilocation.md) | | -| [reward](./bitburner.infiltrationlocation.reward.md) | [InfiltrationReward](./bitburner.infiltrationreward.md) | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [difficulty](./bitburner.infiltrationlocation.difficulty.md) | | number | | +| [location](./bitburner.infiltrationlocation.location.md) | | [ILocation](./bitburner.ilocation.md) | | +| [reward](./bitburner.infiltrationlocation.reward.md) | | [InfiltrationReward](./bitburner.infiltrationreward.md) | | diff --git a/markdown/bitburner.infiltrationlocation.reward.md b/markdown/bitburner.infiltrationlocation.reward.md index a6c38142e..3d7dc879b 100644 --- a/markdown/bitburner.infiltrationlocation.reward.md +++ b/markdown/bitburner.infiltrationlocation.reward.md @@ -4,7 +4,7 @@ ## InfiltrationLocation.reward property -Signature: +**Signature:** ```typescript reward: InfiltrationReward; diff --git a/markdown/bitburner.infiltrationreward.md b/markdown/bitburner.infiltrationreward.md index a8d09efc1..0becc6d0d 100644 --- a/markdown/bitburner.infiltrationreward.md +++ b/markdown/bitburner.infiltrationreward.md @@ -5,7 +5,7 @@ ## InfiltrationReward interface -Signature: +**Signature:** ```typescript interface InfiltrationReward @@ -13,9 +13,9 @@ interface InfiltrationReward ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [sellCash](./bitburner.infiltrationreward.sellcash.md) | number | | -| [SoARep](./bitburner.infiltrationreward.soarep.md) | number | | -| [tradeRep](./bitburner.infiltrationreward.traderep.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [sellCash](./bitburner.infiltrationreward.sellcash.md) | | number | | +| [SoARep](./bitburner.infiltrationreward.soarep.md) | | number | | +| [tradeRep](./bitburner.infiltrationreward.traderep.md) | | number | | diff --git a/markdown/bitburner.infiltrationreward.sellcash.md b/markdown/bitburner.infiltrationreward.sellcash.md index d98b2b67b..84fc224f7 100644 --- a/markdown/bitburner.infiltrationreward.sellcash.md +++ b/markdown/bitburner.infiltrationreward.sellcash.md @@ -4,7 +4,7 @@ ## InfiltrationReward.sellCash property -Signature: +**Signature:** ```typescript sellCash: number; diff --git a/markdown/bitburner.infiltrationreward.soarep.md b/markdown/bitburner.infiltrationreward.soarep.md index cac6ac50d..16b8c1bc2 100644 --- a/markdown/bitburner.infiltrationreward.soarep.md +++ b/markdown/bitburner.infiltrationreward.soarep.md @@ -4,7 +4,7 @@ ## InfiltrationReward.SoARep property -Signature: +**Signature:** ```typescript SoARep: number; diff --git a/markdown/bitburner.infiltrationreward.traderep.md b/markdown/bitburner.infiltrationreward.traderep.md index c3d1d8c79..32d58ea3a 100644 --- a/markdown/bitburner.infiltrationreward.traderep.md +++ b/markdown/bitburner.infiltrationreward.traderep.md @@ -4,7 +4,7 @@ ## InfiltrationReward.tradeRep property -Signature: +**Signature:** ```typescript tradeRep: number; diff --git a/markdown/bitburner.investmentoffer.funds.md b/markdown/bitburner.investmentoffer.funds.md index 77822d27f..286df9b72 100644 --- a/markdown/bitburner.investmentoffer.funds.md +++ b/markdown/bitburner.investmentoffer.funds.md @@ -6,7 +6,7 @@ Amount of funds you will get from this investment -Signature: +**Signature:** ```typescript funds: number; diff --git a/markdown/bitburner.investmentoffer.md b/markdown/bitburner.investmentoffer.md index 4768cc622..3af82ad66 100644 --- a/markdown/bitburner.investmentoffer.md +++ b/markdown/bitburner.investmentoffer.md @@ -6,7 +6,7 @@ Corporation investment offer -Signature: +**Signature:** ```typescript interface InvestmentOffer @@ -14,9 +14,9 @@ interface InvestmentOffer ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [funds](./bitburner.investmentoffer.funds.md) | number | Amount of funds you will get from this investment | -| [round](./bitburner.investmentoffer.round.md) | number | Current round of funding (max 4) | -| [shares](./bitburner.investmentoffer.shares.md) | number | Amount of share you will give in exchange for this investment | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [funds](./bitburner.investmentoffer.funds.md) | | number | Amount of funds you will get from this investment | +| [round](./bitburner.investmentoffer.round.md) | | number | Current round of funding (max 4) | +| [shares](./bitburner.investmentoffer.shares.md) | | number | Amount of share you will give in exchange for this investment | diff --git a/markdown/bitburner.investmentoffer.round.md b/markdown/bitburner.investmentoffer.round.md index 05095029c..ece4525ae 100644 --- a/markdown/bitburner.investmentoffer.round.md +++ b/markdown/bitburner.investmentoffer.round.md @@ -6,7 +6,7 @@ Current round of funding (max 4) -Signature: +**Signature:** ```typescript round: number; diff --git a/markdown/bitburner.investmentoffer.shares.md b/markdown/bitburner.investmentoffer.shares.md index 7c3a2e0a1..8c1cc18fd 100644 --- a/markdown/bitburner.investmentoffer.shares.md +++ b/markdown/bitburner.investmentoffer.shares.md @@ -6,7 +6,7 @@ Amount of share you will give in exchange for this investment -Signature: +**Signature:** ```typescript shares: number; diff --git a/markdown/bitburner.istylesettings.fontfamily.md b/markdown/bitburner.istylesettings.fontfamily.md index f4cbd265c..c6504fc7a 100644 --- a/markdown/bitburner.istylesettings.fontfamily.md +++ b/markdown/bitburner.istylesettings.fontfamily.md @@ -4,7 +4,7 @@ ## IStyleSettings.fontFamily property -Signature: +**Signature:** ```typescript fontFamily: string; diff --git a/markdown/bitburner.istylesettings.lineheight.md b/markdown/bitburner.istylesettings.lineheight.md index 23fa29863..a8bdb1004 100644 --- a/markdown/bitburner.istylesettings.lineheight.md +++ b/markdown/bitburner.istylesettings.lineheight.md @@ -4,7 +4,7 @@ ## IStyleSettings.lineHeight property -Signature: +**Signature:** ```typescript lineHeight: number; diff --git a/markdown/bitburner.istylesettings.md b/markdown/bitburner.istylesettings.md index 0b88e86ba..75c364318 100644 --- a/markdown/bitburner.istylesettings.md +++ b/markdown/bitburner.istylesettings.md @@ -6,7 +6,7 @@ Interface Styles -Signature: +**Signature:** ```typescript interface IStyleSettings @@ -14,8 +14,8 @@ interface IStyleSettings ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [fontFamily](./bitburner.istylesettings.fontfamily.md) | string | | -| [lineHeight](./bitburner.istylesettings.lineheight.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fontFamily](./bitburner.istylesettings.fontfamily.md) | | string | | +| [lineHeight](./bitburner.istylesettings.lineheight.md) | | number | | diff --git a/markdown/bitburner.jobname.md b/markdown/bitburner.jobname.md index e39fc611a..14cdc4cef 100644 --- a/markdown/bitburner.jobname.md +++ b/markdown/bitburner.jobname.md @@ -5,7 +5,7 @@ ## JobName enum -Signature: +**Signature:** ```typescript declare enum JobName diff --git a/markdown/bitburner.locationname.md b/markdown/bitburner.locationname.md index 63a521d68..62f68d32e 100644 --- a/markdown/bitburner.locationname.md +++ b/markdown/bitburner.locationname.md @@ -6,7 +6,7 @@ Names of all locations -Signature: +**Signature:** ```typescript declare enum LocationName diff --git a/markdown/bitburner.material.cmp.md b/markdown/bitburner.material.cmp.md index 6abd37461..1175f7e19 100644 --- a/markdown/bitburner.material.cmp.md +++ b/markdown/bitburner.material.cmp.md @@ -6,7 +6,7 @@ Competition for the material, only present if "Market Research - Competition" unlocked -Signature: +**Signature:** ```typescript cmp: number | undefined; diff --git a/markdown/bitburner.material.cost.md b/markdown/bitburner.material.cost.md index 48f248d17..347cd5012 100644 --- a/markdown/bitburner.material.cost.md +++ b/markdown/bitburner.material.cost.md @@ -6,7 +6,7 @@ Cost to buy material -Signature: +**Signature:** ```typescript cost: number; diff --git a/markdown/bitburner.material.dmd.md b/markdown/bitburner.material.dmd.md index e68f29afd..770022ccb 100644 --- a/markdown/bitburner.material.dmd.md +++ b/markdown/bitburner.material.dmd.md @@ -6,7 +6,7 @@ Demand for the material, only present if "Market Research - Demand" unlocked -Signature: +**Signature:** ```typescript dmd: number | undefined; diff --git a/markdown/bitburner.material.exp.md b/markdown/bitburner.material.exp.md index 539a1d902..ec26b13c7 100644 --- a/markdown/bitburner.material.exp.md +++ b/markdown/bitburner.material.exp.md @@ -6,7 +6,7 @@ Export orders -Signature: +**Signature:** ```typescript exp: Export[]; diff --git a/markdown/bitburner.material.md b/markdown/bitburner.material.md index 537bdc6d9..e59bbc387 100644 --- a/markdown/bitburner.material.md +++ b/markdown/bitburner.material.md @@ -6,7 +6,7 @@ Material in a warehouse -Signature: +**Signature:** ```typescript interface Material @@ -14,16 +14,16 @@ interface Material ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cmp](./bitburner.material.cmp.md) | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked | -| [cost](./bitburner.material.cost.md) | number | Cost to buy material | -| [dmd](./bitburner.material.dmd.md) | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked | -| [exp](./bitburner.material.exp.md) | [Export](./bitburner.export.md)\[\] | Export orders | -| [name](./bitburner.material.name.md) | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| [prod](./bitburner.material.prod.md) | number | Amount of material produced | -| [qlt](./bitburner.material.qlt.md) | number | Quality of the material | -| [qty](./bitburner.material.qty.md) | number | Amount of material | -| [sCost](./bitburner.material.scost.md) | string \| number | Sell cost, can be "MP+5" | -| [sell](./bitburner.material.sell.md) | number | Amount of material sold | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cmp](./bitburner.material.cmp.md) | | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked | +| [cost](./bitburner.material.cost.md) | | number | Cost to buy material | +| [dmd](./bitburner.material.dmd.md) | | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked | +| [exp](./bitburner.material.exp.md) | | [Export](./bitburner.export.md)\[\] | Export orders | +| [name](./bitburner.material.name.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | +| [prod](./bitburner.material.prod.md) | | number | Amount of material produced | +| [qlt](./bitburner.material.qlt.md) | | number | Quality of the material | +| [qty](./bitburner.material.qty.md) | | number | Amount of material | +| [sCost](./bitburner.material.scost.md) | | string \| number | Sell cost, can be "MP+5" | +| [sell](./bitburner.material.sell.md) | | number | Amount of material sold | diff --git a/markdown/bitburner.material.name.md b/markdown/bitburner.material.name.md index a0780e632..634b3c782 100644 --- a/markdown/bitburner.material.name.md +++ b/markdown/bitburner.material.name.md @@ -6,7 +6,7 @@ Name of the material -Signature: +**Signature:** ```typescript name: CorpMaterialName; diff --git a/markdown/bitburner.material.prod.md b/markdown/bitburner.material.prod.md index e45e4f946..6f8970953 100644 --- a/markdown/bitburner.material.prod.md +++ b/markdown/bitburner.material.prod.md @@ -6,7 +6,7 @@ Amount of material produced -Signature: +**Signature:** ```typescript prod: number; diff --git a/markdown/bitburner.material.qlt.md b/markdown/bitburner.material.qlt.md index 1b0eccadc..4b9d7bf08 100644 --- a/markdown/bitburner.material.qlt.md +++ b/markdown/bitburner.material.qlt.md @@ -6,7 +6,7 @@ Quality of the material -Signature: +**Signature:** ```typescript qlt: number; diff --git a/markdown/bitburner.material.qty.md b/markdown/bitburner.material.qty.md index 148a724ac..b513825ba 100644 --- a/markdown/bitburner.material.qty.md +++ b/markdown/bitburner.material.qty.md @@ -6,7 +6,7 @@ Amount of material -Signature: +**Signature:** ```typescript qty: number; diff --git a/markdown/bitburner.material.scost.md b/markdown/bitburner.material.scost.md index 3a1fadbae..0704f080c 100644 --- a/markdown/bitburner.material.scost.md +++ b/markdown/bitburner.material.scost.md @@ -6,7 +6,7 @@ Sell cost, can be "MP+5" -Signature: +**Signature:** ```typescript sCost: string | number; diff --git a/markdown/bitburner.material.sell.md b/markdown/bitburner.material.sell.md index bde611e26..6c4b2042c 100644 --- a/markdown/bitburner.material.sell.md +++ b/markdown/bitburner.material.sell.md @@ -6,7 +6,7 @@ Amount of material sold -Signature: +**Signature:** ```typescript sell: number; diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 605cb9c48..1a87e4e43 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -36,6 +36,7 @@ | [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) | Corporation material information | | [Corporation](./bitburner.corporation.md) | Corporation API | | [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation | +| [CorpProductData](./bitburner.corpproductdata.md) | Product rating information | | [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. | | [Division](./bitburner.division.md) | Corporation division | | [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. | @@ -93,7 +94,7 @@ | [SleevePerson](./bitburner.sleeveperson.md) | | | [SourceFileLvl](./bitburner.sourcefilelvl.md) | | | [Stanek](./bitburner.stanek.md) | Stanek's Gift API. | -| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) | +| [StockOrder](./bitburner.stockorder.md) |

Return value of [getOrders](./bitburner.tix.getorders.md)

Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md)

| | [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | | [TIX](./bitburner.tix.md) | Stock market API | | [UserInterface](./bitburner.userinterface.md) | User Interface API. | @@ -111,7 +112,6 @@ | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | | | [CorpIndustryName](./bitburner.corpindustryname.md) | | | [CorpMaterialName](./bitburner.corpmaterialname.md) | | -| [CorpProductData](./bitburner.corpproductdata.md) | Product rating information | | [CorpResearchName](./bitburner.corpresearchname.md) | | | [CorpStateName](./bitburner.corpstatename.md) | | | [CorpUnlockName](./bitburner.corpunlockname.md) | | diff --git a/markdown/bitburner.moneysource.augmentations.md b/markdown/bitburner.moneysource.augmentations.md index 93ef6ab91..76538e0f2 100644 --- a/markdown/bitburner.moneysource.augmentations.md +++ b/markdown/bitburner.moneysource.augmentations.md @@ -4,7 +4,7 @@ ## MoneySource.augmentations property -Signature: +**Signature:** ```typescript augmentations: number; diff --git a/markdown/bitburner.moneysource.bladeburner.md b/markdown/bitburner.moneysource.bladeburner.md index cbfe67ddd..807424362 100644 --- a/markdown/bitburner.moneysource.bladeburner.md +++ b/markdown/bitburner.moneysource.bladeburner.md @@ -4,7 +4,7 @@ ## MoneySource.bladeburner property -Signature: +**Signature:** ```typescript bladeburner: number; diff --git a/markdown/bitburner.moneysource.casino.md b/markdown/bitburner.moneysource.casino.md index 8b6349a6c..7edf448b9 100644 --- a/markdown/bitburner.moneysource.casino.md +++ b/markdown/bitburner.moneysource.casino.md @@ -4,7 +4,7 @@ ## MoneySource.casino property -Signature: +**Signature:** ```typescript casino: number; diff --git a/markdown/bitburner.moneysource.class.md b/markdown/bitburner.moneysource.class.md index 06de4e05e..2ece47255 100644 --- a/markdown/bitburner.moneysource.class.md +++ b/markdown/bitburner.moneysource.class.md @@ -4,7 +4,7 @@ ## MoneySource.class property -Signature: +**Signature:** ```typescript class: number; diff --git a/markdown/bitburner.moneysource.codingcontract.md b/markdown/bitburner.moneysource.codingcontract.md index 03a93781b..f6d32d602 100644 --- a/markdown/bitburner.moneysource.codingcontract.md +++ b/markdown/bitburner.moneysource.codingcontract.md @@ -4,7 +4,7 @@ ## MoneySource.codingcontract property -Signature: +**Signature:** ```typescript codingcontract: number; diff --git a/markdown/bitburner.moneysource.corporation.md b/markdown/bitburner.moneysource.corporation.md index 9bebb45f9..1586c3b9a 100644 --- a/markdown/bitburner.moneysource.corporation.md +++ b/markdown/bitburner.moneysource.corporation.md @@ -4,7 +4,7 @@ ## MoneySource.corporation property -Signature: +**Signature:** ```typescript corporation: number; diff --git a/markdown/bitburner.moneysource.crime.md b/markdown/bitburner.moneysource.crime.md index b2b25dc04..fd1f5a435 100644 --- a/markdown/bitburner.moneysource.crime.md +++ b/markdown/bitburner.moneysource.crime.md @@ -4,7 +4,7 @@ ## MoneySource.crime property -Signature: +**Signature:** ```typescript crime: number; diff --git a/markdown/bitburner.moneysource.gang.md b/markdown/bitburner.moneysource.gang.md index f5fce3239..7987db0ad 100644 --- a/markdown/bitburner.moneysource.gang.md +++ b/markdown/bitburner.moneysource.gang.md @@ -4,7 +4,7 @@ ## MoneySource.gang property -Signature: +**Signature:** ```typescript gang: number; diff --git a/markdown/bitburner.moneysource.hacking.md b/markdown/bitburner.moneysource.hacking.md index 267e0c18a..1f7a22e57 100644 --- a/markdown/bitburner.moneysource.hacking.md +++ b/markdown/bitburner.moneysource.hacking.md @@ -4,7 +4,7 @@ ## MoneySource.hacking property -Signature: +**Signature:** ```typescript hacking: number; diff --git a/markdown/bitburner.moneysource.hacknet.md b/markdown/bitburner.moneysource.hacknet.md index e699cc947..b9d934c16 100644 --- a/markdown/bitburner.moneysource.hacknet.md +++ b/markdown/bitburner.moneysource.hacknet.md @@ -4,7 +4,7 @@ ## MoneySource.hacknet property -Signature: +**Signature:** ```typescript hacknet: number; diff --git a/markdown/bitburner.moneysource.hacknet_expenses.md b/markdown/bitburner.moneysource.hacknet_expenses.md index 8d8c0accb..6bc12e450 100644 --- a/markdown/bitburner.moneysource.hacknet_expenses.md +++ b/markdown/bitburner.moneysource.hacknet_expenses.md @@ -4,7 +4,7 @@ ## MoneySource.hacknet\_expenses property -Signature: +**Signature:** ```typescript hacknet_expenses: number; diff --git a/markdown/bitburner.moneysource.hospitalization.md b/markdown/bitburner.moneysource.hospitalization.md index 147f09615..18d87ca4d 100644 --- a/markdown/bitburner.moneysource.hospitalization.md +++ b/markdown/bitburner.moneysource.hospitalization.md @@ -4,7 +4,7 @@ ## MoneySource.hospitalization property -Signature: +**Signature:** ```typescript hospitalization: number; diff --git a/markdown/bitburner.moneysource.infiltration.md b/markdown/bitburner.moneysource.infiltration.md index 313ca1559..bd41e3728 100644 --- a/markdown/bitburner.moneysource.infiltration.md +++ b/markdown/bitburner.moneysource.infiltration.md @@ -4,7 +4,7 @@ ## MoneySource.infiltration property -Signature: +**Signature:** ```typescript infiltration: number; diff --git a/markdown/bitburner.moneysource.md b/markdown/bitburner.moneysource.md index 4229f97e1..e057e8146 100644 --- a/markdown/bitburner.moneysource.md +++ b/markdown/bitburner.moneysource.md @@ -5,7 +5,7 @@ ## MoneySource interface -Signature: +**Signature:** ```typescript interface MoneySource @@ -13,25 +13,25 @@ interface MoneySource ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [augmentations](./bitburner.moneysource.augmentations.md) | number | | -| [bladeburner](./bitburner.moneysource.bladeburner.md) | number | | -| [casino](./bitburner.moneysource.casino.md) | number | | -| [class](./bitburner.moneysource.class.md) | number | | -| [codingcontract](./bitburner.moneysource.codingcontract.md) | number | | -| [corporation](./bitburner.moneysource.corporation.md) | number | | -| [crime](./bitburner.moneysource.crime.md) | number | | -| [gang](./bitburner.moneysource.gang.md) | number | | -| [hacking](./bitburner.moneysource.hacking.md) | number | | -| [hacknet\_expenses](./bitburner.moneysource.hacknet_expenses.md) | number | | -| [hacknet](./bitburner.moneysource.hacknet.md) | number | | -| [hospitalization](./bitburner.moneysource.hospitalization.md) | number | | -| [infiltration](./bitburner.moneysource.infiltration.md) | number | | -| [other](./bitburner.moneysource.other.md) | number | | -| [servers](./bitburner.moneysource.servers.md) | number | | -| [sleeves](./bitburner.moneysource.sleeves.md) | number | | -| [stock](./bitburner.moneysource.stock.md) | number | | -| [total](./bitburner.moneysource.total.md) | number | | -| [work](./bitburner.moneysource.work.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [augmentations](./bitburner.moneysource.augmentations.md) | | number | | +| [bladeburner](./bitburner.moneysource.bladeburner.md) | | number | | +| [casino](./bitburner.moneysource.casino.md) | | number | | +| [class](./bitburner.moneysource.class.md) | | number | | +| [codingcontract](./bitburner.moneysource.codingcontract.md) | | number | | +| [corporation](./bitburner.moneysource.corporation.md) | | number | | +| [crime](./bitburner.moneysource.crime.md) | | number | | +| [gang](./bitburner.moneysource.gang.md) | | number | | +| [hacking](./bitburner.moneysource.hacking.md) | | number | | +| [hacknet\_expenses](./bitburner.moneysource.hacknet_expenses.md) | | number | | +| [hacknet](./bitburner.moneysource.hacknet.md) | | number | | +| [hospitalization](./bitburner.moneysource.hospitalization.md) | | number | | +| [infiltration](./bitburner.moneysource.infiltration.md) | | number | | +| [other](./bitburner.moneysource.other.md) | | number | | +| [servers](./bitburner.moneysource.servers.md) | | number | | +| [sleeves](./bitburner.moneysource.sleeves.md) | | number | | +| [stock](./bitburner.moneysource.stock.md) | | number | | +| [total](./bitburner.moneysource.total.md) | | number | | +| [work](./bitburner.moneysource.work.md) | | number | | diff --git a/markdown/bitburner.moneysource.other.md b/markdown/bitburner.moneysource.other.md index 8325161b3..ad8e58bee 100644 --- a/markdown/bitburner.moneysource.other.md +++ b/markdown/bitburner.moneysource.other.md @@ -4,7 +4,7 @@ ## MoneySource.other property -Signature: +**Signature:** ```typescript other: number; diff --git a/markdown/bitburner.moneysource.servers.md b/markdown/bitburner.moneysource.servers.md index 2ed8fd6e1..8d6e612c5 100644 --- a/markdown/bitburner.moneysource.servers.md +++ b/markdown/bitburner.moneysource.servers.md @@ -4,7 +4,7 @@ ## MoneySource.servers property -Signature: +**Signature:** ```typescript servers: number; diff --git a/markdown/bitburner.moneysource.sleeves.md b/markdown/bitburner.moneysource.sleeves.md index edfa122b6..82dec8da1 100644 --- a/markdown/bitburner.moneysource.sleeves.md +++ b/markdown/bitburner.moneysource.sleeves.md @@ -4,7 +4,7 @@ ## MoneySource.sleeves property -Signature: +**Signature:** ```typescript sleeves: number; diff --git a/markdown/bitburner.moneysource.stock.md b/markdown/bitburner.moneysource.stock.md index 0945cffd7..748e36ce1 100644 --- a/markdown/bitburner.moneysource.stock.md +++ b/markdown/bitburner.moneysource.stock.md @@ -4,7 +4,7 @@ ## MoneySource.stock property -Signature: +**Signature:** ```typescript stock: number; diff --git a/markdown/bitburner.moneysource.total.md b/markdown/bitburner.moneysource.total.md index 3ecaf45f5..3f8ec2817 100644 --- a/markdown/bitburner.moneysource.total.md +++ b/markdown/bitburner.moneysource.total.md @@ -4,7 +4,7 @@ ## MoneySource.total property -Signature: +**Signature:** ```typescript total: number; diff --git a/markdown/bitburner.moneysource.work.md b/markdown/bitburner.moneysource.work.md index 651a296a9..f5703a576 100644 --- a/markdown/bitburner.moneysource.work.md +++ b/markdown/bitburner.moneysource.work.md @@ -4,7 +4,7 @@ ## MoneySource.work property -Signature: +**Signature:** ```typescript work: number; diff --git a/markdown/bitburner.moneysources.md b/markdown/bitburner.moneysources.md index 6a4feb072..810b8fe88 100644 --- a/markdown/bitburner.moneysources.md +++ b/markdown/bitburner.moneysources.md @@ -5,7 +5,7 @@ ## MoneySources interface -Signature: +**Signature:** ```typescript interface MoneySources @@ -13,8 +13,8 @@ interface MoneySources ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [sinceInstall](./bitburner.moneysources.sinceinstall.md) | [MoneySource](./bitburner.moneysource.md) | | -| [sinceStart](./bitburner.moneysources.sincestart.md) | [MoneySource](./bitburner.moneysource.md) | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [sinceInstall](./bitburner.moneysources.sinceinstall.md) | | [MoneySource](./bitburner.moneysource.md) | | +| [sinceStart](./bitburner.moneysources.sincestart.md) | | [MoneySource](./bitburner.moneysource.md) | | diff --git a/markdown/bitburner.moneysources.sinceinstall.md b/markdown/bitburner.moneysources.sinceinstall.md index f49ec1d50..ef322fbe1 100644 --- a/markdown/bitburner.moneysources.sinceinstall.md +++ b/markdown/bitburner.moneysources.sinceinstall.md @@ -4,7 +4,7 @@ ## MoneySources.sinceInstall property -Signature: +**Signature:** ```typescript sinceInstall: MoneySource; diff --git a/markdown/bitburner.moneysources.sincestart.md b/markdown/bitburner.moneysources.sincestart.md index b3815d1ff..ff4879d40 100644 --- a/markdown/bitburner.moneysources.sincestart.md +++ b/markdown/bitburner.moneysources.sincestart.md @@ -4,7 +4,7 @@ ## MoneySources.sinceStart property -Signature: +**Signature:** ```typescript sinceStart: MoneySource; diff --git a/markdown/bitburner.multipliers.agility.md b/markdown/bitburner.multipliers.agility.md index 20585bc38..8fd919522 100644 --- a/markdown/bitburner.multipliers.agility.md +++ b/markdown/bitburner.multipliers.agility.md @@ -6,7 +6,7 @@ Multiplier to agility skill -Signature: +**Signature:** ```typescript agility: number; diff --git a/markdown/bitburner.multipliers.agility_exp.md b/markdown/bitburner.multipliers.agility_exp.md index 8fa3bd538..4a4380398 100644 --- a/markdown/bitburner.multipliers.agility_exp.md +++ b/markdown/bitburner.multipliers.agility_exp.md @@ -6,7 +6,7 @@ Multiplier to agility experience gain rate -Signature: +**Signature:** ```typescript agility_exp: number; diff --git a/markdown/bitburner.multipliers.bladeburner_analysis.md b/markdown/bitburner.multipliers.bladeburner_analysis.md index 2d9139730..53652b41c 100644 --- a/markdown/bitburner.multipliers.bladeburner_analysis.md +++ b/markdown/bitburner.multipliers.bladeburner_analysis.md @@ -6,7 +6,7 @@ Multiplier to effectiveness in Bladeburner Field Analysis -Signature: +**Signature:** ```typescript bladeburner_analysis: number; diff --git a/markdown/bitburner.multipliers.bladeburner_max_stamina.md b/markdown/bitburner.multipliers.bladeburner_max_stamina.md index a8cc6e894..57a2db124 100644 --- a/markdown/bitburner.multipliers.bladeburner_max_stamina.md +++ b/markdown/bitburner.multipliers.bladeburner_max_stamina.md @@ -6,7 +6,7 @@ Multiplier to Bladeburner max stamina -Signature: +**Signature:** ```typescript bladeburner_max_stamina: number; diff --git a/markdown/bitburner.multipliers.bladeburner_stamina_gain.md b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md index e788d5270..e29f38f5b 100644 --- a/markdown/bitburner.multipliers.bladeburner_stamina_gain.md +++ b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md @@ -6,7 +6,7 @@ Multiplier to Bladeburner stamina gain rate -Signature: +**Signature:** ```typescript bladeburner_stamina_gain: number; diff --git a/markdown/bitburner.multipliers.bladeburner_success_chance.md b/markdown/bitburner.multipliers.bladeburner_success_chance.md index 7fdadf337..bd6a07e05 100644 --- a/markdown/bitburner.multipliers.bladeburner_success_chance.md +++ b/markdown/bitburner.multipliers.bladeburner_success_chance.md @@ -6,7 +6,7 @@ Multiplier to success chance in Bladeburner contracts/operations -Signature: +**Signature:** ```typescript bladeburner_success_chance: number; diff --git a/markdown/bitburner.multipliers.charisma.md b/markdown/bitburner.multipliers.charisma.md index a0e97bb18..00a6707c4 100644 --- a/markdown/bitburner.multipliers.charisma.md +++ b/markdown/bitburner.multipliers.charisma.md @@ -6,7 +6,7 @@ Multiplier to charisma skill -Signature: +**Signature:** ```typescript charisma: number; diff --git a/markdown/bitburner.multipliers.charisma_exp.md b/markdown/bitburner.multipliers.charisma_exp.md index 0df9127b0..a05c98bc0 100644 --- a/markdown/bitburner.multipliers.charisma_exp.md +++ b/markdown/bitburner.multipliers.charisma_exp.md @@ -6,7 +6,7 @@ Multiplier to charisma experience gain rate -Signature: +**Signature:** ```typescript charisma_exp: number; diff --git a/markdown/bitburner.multipliers.company_rep.md b/markdown/bitburner.multipliers.company_rep.md index 437fd6899..1584d713a 100644 --- a/markdown/bitburner.multipliers.company_rep.md +++ b/markdown/bitburner.multipliers.company_rep.md @@ -6,7 +6,7 @@ Multiplier to amount of reputation gained when working -Signature: +**Signature:** ```typescript company_rep: number; diff --git a/markdown/bitburner.multipliers.crime_money.md b/markdown/bitburner.multipliers.crime_money.md index 2661c6a5b..fd50aec2e 100644 --- a/markdown/bitburner.multipliers.crime_money.md +++ b/markdown/bitburner.multipliers.crime_money.md @@ -6,7 +6,7 @@ Multiplier to amount of money gained from crimes -Signature: +**Signature:** ```typescript crime_money: number; diff --git a/markdown/bitburner.multipliers.crime_success.md b/markdown/bitburner.multipliers.crime_success.md index 786833272..a7c924613 100644 --- a/markdown/bitburner.multipliers.crime_success.md +++ b/markdown/bitburner.multipliers.crime_success.md @@ -6,7 +6,7 @@ Multiplier to crime success rate -Signature: +**Signature:** ```typescript crime_success: number; diff --git a/markdown/bitburner.multipliers.defense.md b/markdown/bitburner.multipliers.defense.md index ac3f167a7..8b5b05756 100644 --- a/markdown/bitburner.multipliers.defense.md +++ b/markdown/bitburner.multipliers.defense.md @@ -6,7 +6,7 @@ Multiplier to defense skill -Signature: +**Signature:** ```typescript defense: number; diff --git a/markdown/bitburner.multipliers.defense_exp.md b/markdown/bitburner.multipliers.defense_exp.md index 75f00f129..1b48ef7a3 100644 --- a/markdown/bitburner.multipliers.defense_exp.md +++ b/markdown/bitburner.multipliers.defense_exp.md @@ -6,7 +6,7 @@ Multiplier to defense experience gain rate -Signature: +**Signature:** ```typescript defense_exp: number; diff --git a/markdown/bitburner.multipliers.dexterity.md b/markdown/bitburner.multipliers.dexterity.md index 8b6b06871..4a86d26ba 100644 --- a/markdown/bitburner.multipliers.dexterity.md +++ b/markdown/bitburner.multipliers.dexterity.md @@ -6,7 +6,7 @@ Multiplier to dexterity skill -Signature: +**Signature:** ```typescript dexterity: number; diff --git a/markdown/bitburner.multipliers.dexterity_exp.md b/markdown/bitburner.multipliers.dexterity_exp.md index ac8257621..09d22c2b7 100644 --- a/markdown/bitburner.multipliers.dexterity_exp.md +++ b/markdown/bitburner.multipliers.dexterity_exp.md @@ -6,7 +6,7 @@ Multiplier to dexterity experience gain rate -Signature: +**Signature:** ```typescript dexterity_exp: number; diff --git a/markdown/bitburner.multipliers.faction_rep.md b/markdown/bitburner.multipliers.faction_rep.md index fe87569a6..99afafacf 100644 --- a/markdown/bitburner.multipliers.faction_rep.md +++ b/markdown/bitburner.multipliers.faction_rep.md @@ -6,7 +6,7 @@ Multiplier to amount of reputation gained when working -Signature: +**Signature:** ```typescript faction_rep: number; diff --git a/markdown/bitburner.multipliers.hacking.md b/markdown/bitburner.multipliers.hacking.md index 724b17954..ea58e86f2 100644 --- a/markdown/bitburner.multipliers.hacking.md +++ b/markdown/bitburner.multipliers.hacking.md @@ -6,7 +6,7 @@ Multiplier to hacking skill -Signature: +**Signature:** ```typescript hacking: number; diff --git a/markdown/bitburner.multipliers.hacking_chance.md b/markdown/bitburner.multipliers.hacking_chance.md index 13c132daa..3e22ec055 100644 --- a/markdown/bitburner.multipliers.hacking_chance.md +++ b/markdown/bitburner.multipliers.hacking_chance.md @@ -6,7 +6,7 @@ Multiplier to chance of successfully performing a hack -Signature: +**Signature:** ```typescript hacking_chance: number; diff --git a/markdown/bitburner.multipliers.hacking_exp.md b/markdown/bitburner.multipliers.hacking_exp.md index 8f2254ef7..ce3d2d480 100644 --- a/markdown/bitburner.multipliers.hacking_exp.md +++ b/markdown/bitburner.multipliers.hacking_exp.md @@ -6,7 +6,7 @@ Multiplier to hacking experience gain rate -Signature: +**Signature:** ```typescript hacking_exp: number; diff --git a/markdown/bitburner.multipliers.hacking_grow.md b/markdown/bitburner.multipliers.hacking_grow.md index ed99b9dc8..f582665a4 100644 --- a/markdown/bitburner.multipliers.hacking_grow.md +++ b/markdown/bitburner.multipliers.hacking_grow.md @@ -6,7 +6,7 @@ Multiplier to amount of money injected into servers using grow -Signature: +**Signature:** ```typescript hacking_grow: number; diff --git a/markdown/bitburner.multipliers.hacking_money.md b/markdown/bitburner.multipliers.hacking_money.md index 3f2711589..72ff7adb6 100644 --- a/markdown/bitburner.multipliers.hacking_money.md +++ b/markdown/bitburner.multipliers.hacking_money.md @@ -6,7 +6,7 @@ Multiplier to amount of money the player gains from hacking -Signature: +**Signature:** ```typescript hacking_money: number; diff --git a/markdown/bitburner.multipliers.hacking_speed.md b/markdown/bitburner.multipliers.hacking_speed.md index 9829bd592..f044a386d 100644 --- a/markdown/bitburner.multipliers.hacking_speed.md +++ b/markdown/bitburner.multipliers.hacking_speed.md @@ -6,7 +6,7 @@ Multiplier to hacking speed -Signature: +**Signature:** ```typescript hacking_speed: number; diff --git a/markdown/bitburner.multipliers.hacknet_node_core_cost.md b/markdown/bitburner.multipliers.hacknet_node_core_cost.md index 80c146d22..bd04ff0e7 100644 --- a/markdown/bitburner.multipliers.hacknet_node_core_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_core_cost.md @@ -6,7 +6,7 @@ Multiplier to cost of core for a Hacknet Node -Signature: +**Signature:** ```typescript hacknet_node_core_cost: number; diff --git a/markdown/bitburner.multipliers.hacknet_node_level_cost.md b/markdown/bitburner.multipliers.hacknet_node_level_cost.md index 31c531c6f..b9cc5ed99 100644 --- a/markdown/bitburner.multipliers.hacknet_node_level_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_level_cost.md @@ -6,7 +6,7 @@ Multiplier to cost of leveling up a Hacknet Node -Signature: +**Signature:** ```typescript hacknet_node_level_cost: number; diff --git a/markdown/bitburner.multipliers.hacknet_node_money.md b/markdown/bitburner.multipliers.hacknet_node_money.md index 68a8f64a4..19545bd11 100644 --- a/markdown/bitburner.multipliers.hacknet_node_money.md +++ b/markdown/bitburner.multipliers.hacknet_node_money.md @@ -6,7 +6,7 @@ Multiplier to amount of money produced by Hacknet Nodes -Signature: +**Signature:** ```typescript hacknet_node_money: number; diff --git a/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md index 4a2f82561..a13c5c8c0 100644 --- a/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md @@ -6,7 +6,7 @@ Multiplier to cost of purchasing a Hacknet Node -Signature: +**Signature:** ```typescript hacknet_node_purchase_cost: number; diff --git a/markdown/bitburner.multipliers.hacknet_node_ram_cost.md b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md index 214f09893..8a3ee7dc8 100644 --- a/markdown/bitburner.multipliers.hacknet_node_ram_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md @@ -6,7 +6,7 @@ Multiplier to cost of ram for a Hacknet Node -Signature: +**Signature:** ```typescript hacknet_node_ram_cost: number; diff --git a/markdown/bitburner.multipliers.md b/markdown/bitburner.multipliers.md index 5e713fe7b..1d8c82102 100644 --- a/markdown/bitburner.multipliers.md +++ b/markdown/bitburner.multipliers.md @@ -5,7 +5,7 @@ ## Multipliers interface -Signature: +**Signature:** ```typescript interface Multipliers @@ -13,36 +13,36 @@ interface Multipliers ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agility\_exp](./bitburner.multipliers.agility_exp.md) | number | Multiplier to agility experience gain rate | -| [agility](./bitburner.multipliers.agility.md) | number | Multiplier to agility skill | -| [bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) | number | Multiplier to effectiveness in Bladeburner Field Analysis | -| [bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) | number | Multiplier to Bladeburner max stamina | -| [bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) | number | Multiplier to Bladeburner stamina gain rate | -| [bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) | number | Multiplier to success chance in Bladeburner contracts/operations | -| [charisma\_exp](./bitburner.multipliers.charisma_exp.md) | number | Multiplier to charisma experience gain rate | -| [charisma](./bitburner.multipliers.charisma.md) | number | Multiplier to charisma skill | -| [company\_rep](./bitburner.multipliers.company_rep.md) | number | Multiplier to amount of reputation gained when working | -| [crime\_money](./bitburner.multipliers.crime_money.md) | number | Multiplier to amount of money gained from crimes | -| [crime\_success](./bitburner.multipliers.crime_success.md) | number | Multiplier to crime success rate | -| [defense\_exp](./bitburner.multipliers.defense_exp.md) | number | Multiplier to defense experience gain rate | -| [defense](./bitburner.multipliers.defense.md) | number | Multiplier to defense skill | -| [dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) | number | Multiplier to dexterity experience gain rate | -| [dexterity](./bitburner.multipliers.dexterity.md) | number | Multiplier to dexterity skill | -| [faction\_rep](./bitburner.multipliers.faction_rep.md) | number | Multiplier to amount of reputation gained when working | -| [hacking\_chance](./bitburner.multipliers.hacking_chance.md) | number | Multiplier to chance of successfully performing a hack | -| [hacking\_exp](./bitburner.multipliers.hacking_exp.md) | number | Multiplier to hacking experience gain rate | -| [hacking\_grow](./bitburner.multipliers.hacking_grow.md) | number | Multiplier to amount of money injected into servers using grow | -| [hacking\_money](./bitburner.multipliers.hacking_money.md) | number | Multiplier to amount of money the player gains from hacking | -| [hacking\_speed](./bitburner.multipliers.hacking_speed.md) | number | Multiplier to hacking speed | -| [hacking](./bitburner.multipliers.hacking.md) | number | Multiplier to hacking skill | -| [hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) | number | Multiplier to cost of core for a Hacknet Node | -| [hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) | number | Multiplier to cost of leveling up a Hacknet Node | -| [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) | number | Multiplier to amount of money produced by Hacknet Nodes | -| [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) | number | Multiplier to cost of purchasing a Hacknet Node | -| [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) | number | Multiplier to cost of ram for a Hacknet Node | -| [strength\_exp](./bitburner.multipliers.strength_exp.md) | number | Multiplier to strength experience gain rate | -| [strength](./bitburner.multipliers.strength.md) | number | Multiplier to strength skill | -| [work\_money](./bitburner.multipliers.work_money.md) | number | Multiplier to amount of money gained from working | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agility\_exp](./bitburner.multipliers.agility_exp.md) | | number | Multiplier to agility experience gain rate | +| [agility](./bitburner.multipliers.agility.md) | | number | Multiplier to agility skill | +| [bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) | | number | Multiplier to effectiveness in Bladeburner Field Analysis | +| [bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) | | number | Multiplier to Bladeburner max stamina | +| [bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) | | number | Multiplier to Bladeburner stamina gain rate | +| [bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) | | number | Multiplier to success chance in Bladeburner contracts/operations | +| [charisma\_exp](./bitburner.multipliers.charisma_exp.md) | | number | Multiplier to charisma experience gain rate | +| [charisma](./bitburner.multipliers.charisma.md) | | number | Multiplier to charisma skill | +| [company\_rep](./bitburner.multipliers.company_rep.md) | | number | Multiplier to amount of reputation gained when working | +| [crime\_money](./bitburner.multipliers.crime_money.md) | | number | Multiplier to amount of money gained from crimes | +| [crime\_success](./bitburner.multipliers.crime_success.md) | | number | Multiplier to crime success rate | +| [defense\_exp](./bitburner.multipliers.defense_exp.md) | | number | Multiplier to defense experience gain rate | +| [defense](./bitburner.multipliers.defense.md) | | number | Multiplier to defense skill | +| [dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) | | number | Multiplier to dexterity experience gain rate | +| [dexterity](./bitburner.multipliers.dexterity.md) | | number | Multiplier to dexterity skill | +| [faction\_rep](./bitburner.multipliers.faction_rep.md) | | number | Multiplier to amount of reputation gained when working | +| [hacking\_chance](./bitburner.multipliers.hacking_chance.md) | | number | Multiplier to chance of successfully performing a hack | +| [hacking\_exp](./bitburner.multipliers.hacking_exp.md) | | number | Multiplier to hacking experience gain rate | +| [hacking\_grow](./bitburner.multipliers.hacking_grow.md) | | number | Multiplier to amount of money injected into servers using grow | +| [hacking\_money](./bitburner.multipliers.hacking_money.md) | | number | Multiplier to amount of money the player gains from hacking | +| [hacking\_speed](./bitburner.multipliers.hacking_speed.md) | | number | Multiplier to hacking speed | +| [hacking](./bitburner.multipliers.hacking.md) | | number | Multiplier to hacking skill | +| [hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) | | number | Multiplier to cost of core for a Hacknet Node | +| [hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) | | number | Multiplier to cost of leveling up a Hacknet Node | +| [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) | | number | Multiplier to amount of money produced by Hacknet Nodes | +| [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) | | number | Multiplier to cost of purchasing a Hacknet Node | +| [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) | | number | Multiplier to cost of ram for a Hacknet Node | +| [strength\_exp](./bitburner.multipliers.strength_exp.md) | | number | Multiplier to strength experience gain rate | +| [strength](./bitburner.multipliers.strength.md) | | number | Multiplier to strength skill | +| [work\_money](./bitburner.multipliers.work_money.md) | | number | Multiplier to amount of money gained from working | diff --git a/markdown/bitburner.multipliers.strength.md b/markdown/bitburner.multipliers.strength.md index 8ada3414d..b94d0b9b5 100644 --- a/markdown/bitburner.multipliers.strength.md +++ b/markdown/bitburner.multipliers.strength.md @@ -6,7 +6,7 @@ Multiplier to strength skill -Signature: +**Signature:** ```typescript strength: number; diff --git a/markdown/bitburner.multipliers.strength_exp.md b/markdown/bitburner.multipliers.strength_exp.md index a4d1d8645..1fad80020 100644 --- a/markdown/bitburner.multipliers.strength_exp.md +++ b/markdown/bitburner.multipliers.strength_exp.md @@ -6,7 +6,7 @@ Multiplier to strength experience gain rate -Signature: +**Signature:** ```typescript strength_exp: number; diff --git a/markdown/bitburner.multipliers.work_money.md b/markdown/bitburner.multipliers.work_money.md index c6e4e2a8a..037640a78 100644 --- a/markdown/bitburner.multipliers.work_money.md +++ b/markdown/bitburner.multipliers.work_money.md @@ -6,7 +6,7 @@ Multiplier to amount of money gained from working -Signature: +**Signature:** ```typescript work_money: number; diff --git a/markdown/bitburner.netscriptport.clear.md b/markdown/bitburner.netscriptport.clear.md index a3c2d5267..380fecce6 100644 --- a/markdown/bitburner.netscriptport.clear.md +++ b/markdown/bitburner.netscriptport.clear.md @@ -6,12 +6,12 @@ Empties all data from the port. -Signature: +**Signature:** ```typescript clear(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.netscriptport.empty.md b/markdown/bitburner.netscriptport.empty.md index 50e3b972d..a195af76d 100644 --- a/markdown/bitburner.netscriptport.empty.md +++ b/markdown/bitburner.netscriptport.empty.md @@ -6,12 +6,12 @@ Check if the port is empty. -Signature: +**Signature:** ```typescript empty(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.netscriptport.full.md b/markdown/bitburner.netscriptport.full.md index b21d20999..bdeae6f44 100644 --- a/markdown/bitburner.netscriptport.full.md +++ b/markdown/bitburner.netscriptport.full.md @@ -6,12 +6,12 @@ Check if the port is full. -Signature: +**Signature:** ```typescript full(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.netscriptport.md b/markdown/bitburner.netscriptport.md index af210fcea..e6214424b 100644 --- a/markdown/bitburner.netscriptport.md +++ b/markdown/bitburner.netscriptport.md @@ -6,7 +6,7 @@ Object representing a port. A port is a serialized queue. -Signature: +**Signature:** ```typescript interface NetscriptPort diff --git a/markdown/bitburner.netscriptport.nextwrite.md b/markdown/bitburner.netscriptport.nextwrite.md index 7edee092b..fa7ebffcd 100644 --- a/markdown/bitburner.netscriptport.nextwrite.md +++ b/markdown/bitburner.netscriptport.nextwrite.md @@ -6,12 +6,12 @@ Sleeps until the port is written to. -Signature: +**Signature:** ```typescript nextWrite(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/markdown/bitburner.netscriptport.peek.md b/markdown/bitburner.netscriptport.peek.md index 4a3363045..6c2267d04 100644 --- a/markdown/bitburner.netscriptport.peek.md +++ b/markdown/bitburner.netscriptport.peek.md @@ -6,12 +6,12 @@ Retrieve the first element from the port without removing it. -Signature: +**Signature:** ```typescript peek(): PortData; ``` -Returns: +**Returns:** [PortData](./bitburner.portdata.md) diff --git a/markdown/bitburner.netscriptport.read.md b/markdown/bitburner.netscriptport.read.md index 6f22960cb..b9eea7bd8 100644 --- a/markdown/bitburner.netscriptport.read.md +++ b/markdown/bitburner.netscriptport.read.md @@ -6,12 +6,12 @@ Shift an element out of the port. -Signature: +**Signature:** ```typescript read(): PortData; ``` -Returns: +**Returns:** [PortData](./bitburner.portdata.md) diff --git a/markdown/bitburner.netscriptport.trywrite.md b/markdown/bitburner.netscriptport.trywrite.md index 0a7df6d19..051a54839 100644 --- a/markdown/bitburner.netscriptport.trywrite.md +++ b/markdown/bitburner.netscriptport.trywrite.md @@ -6,7 +6,7 @@ Attempt to write data to the port. -Signature: +**Signature:** ```typescript tryWrite(value: string | number): boolean; @@ -18,7 +18,7 @@ tryWrite(value: string | number): boolean; | --- | --- | --- | | value | string \| number | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.netscriptport.write.md b/markdown/bitburner.netscriptport.write.md index f4435e944..f099676e4 100644 --- a/markdown/bitburner.netscriptport.write.md +++ b/markdown/bitburner.netscriptport.write.md @@ -6,7 +6,7 @@ Write data to a port. -Signature: +**Signature:** ```typescript write(value: string | number): PortData | null; @@ -18,7 +18,7 @@ write(value: string | number): PortData | null; | --- | --- | --- | | value | string \| number | | -Returns: +**Returns:** [PortData](./bitburner.portdata.md) \| null diff --git a/markdown/bitburner.nodestats.cache.md b/markdown/bitburner.nodestats.cache.md index dc7f46034..7344f194c 100644 --- a/markdown/bitburner.nodestats.cache.md +++ b/markdown/bitburner.nodestats.cache.md @@ -6,7 +6,7 @@ Cache level. Only applicable for Hacknet Servers -Signature: +**Signature:** ```typescript cache?: number; diff --git a/markdown/bitburner.nodestats.cores.md b/markdown/bitburner.nodestats.cores.md index 1f172625d..f2ed1265d 100644 --- a/markdown/bitburner.nodestats.cores.md +++ b/markdown/bitburner.nodestats.cores.md @@ -6,7 +6,7 @@ Node's number of cores -Signature: +**Signature:** ```typescript cores: number; diff --git a/markdown/bitburner.nodestats.hashcapacity.md b/markdown/bitburner.nodestats.hashcapacity.md index c63301993..6db11020b 100644 --- a/markdown/bitburner.nodestats.hashcapacity.md +++ b/markdown/bitburner.nodestats.hashcapacity.md @@ -6,7 +6,7 @@ Hash Capacity provided by this Node. Only applicable for Hacknet Servers -Signature: +**Signature:** ```typescript hashCapacity?: number; diff --git a/markdown/bitburner.nodestats.level.md b/markdown/bitburner.nodestats.level.md index f4831524c..6be275a42 100644 --- a/markdown/bitburner.nodestats.level.md +++ b/markdown/bitburner.nodestats.level.md @@ -6,7 +6,7 @@ Node's level -Signature: +**Signature:** ```typescript level: number; diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md index b0ade5673..88c5b8100 100644 --- a/markdown/bitburner.nodestats.md +++ b/markdown/bitburner.nodestats.md @@ -6,7 +6,7 @@ Object representing all the values related to a hacknet node. -Signature: +**Signature:** ```typescript interface NodeStats @@ -14,16 +14,16 @@ interface NodeStats ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cache?](./bitburner.nodestats.cache.md) | number | (Optional) Cache level. Only applicable for Hacknet Servers | -| [cores](./bitburner.nodestats.cores.md) | number | Node's number of cores | -| [hashCapacity?](./bitburner.nodestats.hashcapacity.md) | number | (Optional) 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 | -| [production](./bitburner.nodestats.production.md) | number | Node's production per second | -| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM (GB) | -| [ramUsed?](./bitburner.nodestats.ramused.md) | number | (Optional) Node's used RAM (GB) | -| [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 | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cache?](./bitburner.nodestats.cache.md) | | number | _(Optional)_ Cache level. Only applicable for Hacknet Servers | +| [cores](./bitburner.nodestats.cores.md) | | number | Node's number of cores | +| [hashCapacity?](./bitburner.nodestats.hashcapacity.md) | | number | _(Optional)_ 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 | +| [production](./bitburner.nodestats.production.md) | | number | Node's production per second | +| [ram](./bitburner.nodestats.ram.md) | | number | Node's RAM (GB) | +| [ramUsed?](./bitburner.nodestats.ramused.md) | | number | _(Optional)_ Node's used RAM (GB) | +| [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 index 04b7ec8d2..bf948c05f 100644 --- a/markdown/bitburner.nodestats.name.md +++ b/markdown/bitburner.nodestats.name.md @@ -6,7 +6,7 @@ Node's name -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.nodestats.production.md b/markdown/bitburner.nodestats.production.md index efa0eecb0..b374fd118 100644 --- a/markdown/bitburner.nodestats.production.md +++ b/markdown/bitburner.nodestats.production.md @@ -6,7 +6,7 @@ Node's production per second -Signature: +**Signature:** ```typescript production: number; diff --git a/markdown/bitburner.nodestats.ram.md b/markdown/bitburner.nodestats.ram.md index 4160f7b9c..1a2ff33bc 100644 --- a/markdown/bitburner.nodestats.ram.md +++ b/markdown/bitburner.nodestats.ram.md @@ -6,7 +6,7 @@ Node's RAM (GB) -Signature: +**Signature:** ```typescript ram: number; diff --git a/markdown/bitburner.nodestats.ramused.md b/markdown/bitburner.nodestats.ramused.md index a7f79cfb0..b90f73ff6 100644 --- a/markdown/bitburner.nodestats.ramused.md +++ b/markdown/bitburner.nodestats.ramused.md @@ -6,7 +6,7 @@ Node's used RAM (GB) -Signature: +**Signature:** ```typescript ramUsed?: number; diff --git a/markdown/bitburner.nodestats.timeonline.md b/markdown/bitburner.nodestats.timeonline.md index 0ce7e92e9..a4238d9db 100644 --- a/markdown/bitburner.nodestats.timeonline.md +++ b/markdown/bitburner.nodestats.timeonline.md @@ -6,7 +6,7 @@ Number of seconds since Node has been purchased -Signature: +**Signature:** ```typescript timeOnline: number; diff --git a/markdown/bitburner.nodestats.totalproduction.md b/markdown/bitburner.nodestats.totalproduction.md index d5e3c7b7e..7f825fa91 100644 --- a/markdown/bitburner.nodestats.totalproduction.md +++ b/markdown/bitburner.nodestats.totalproduction.md @@ -6,7 +6,7 @@ Total number of money Node has produced -Signature: +**Signature:** ```typescript totalProduction: number; diff --git a/markdown/bitburner.ns.alert.md b/markdown/bitburner.ns.alert.md index 0a9f1ccce..5772ebcdc 100644 --- a/markdown/bitburner.ns.alert.md +++ b/markdown/bitburner.ns.alert.md @@ -6,7 +6,7 @@ Open up a message box. -Signature: +**Signature:** ```typescript alert(msg: string): void; @@ -18,7 +18,7 @@ alert(msg: string): void; | --- | --- | --- | | msg | string | Message to alert. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.args.md b/markdown/bitburner.ns.args.md index 60c8c1a41..4d3222ad5 100644 --- a/markdown/bitburner.ns.args.md +++ b/markdown/bitburner.ns.args.md @@ -6,7 +6,7 @@ Arguments passed into the script. -Signature: +**Signature:** ```typescript readonly args: (string | number | boolean)[]; diff --git a/markdown/bitburner.ns.asleep.md b/markdown/bitburner.ns.asleep.md index 275690aa0..7f44ebdd6 100644 --- a/markdown/bitburner.ns.asleep.md +++ b/markdown/bitburner.ns.asleep.md @@ -6,7 +6,7 @@ Suspends the script for n milliseconds. Doesn't block with concurrent calls. You should prefer 'sleep' over 'asleep' except when doing very complex UI work. -Signature: +**Signature:** ```typescript asleep(millis: number): Promise; @@ -18,7 +18,7 @@ asleep(millis: number): Promise; | --- | --- | --- | | millis | number | Number of milliseconds to sleep. | -Returns: +**Returns:** Promise<true> diff --git a/markdown/bitburner.ns.atexit.md b/markdown/bitburner.ns.atexit.md index 872dbfc8c..21d5cd077 100644 --- a/markdown/bitburner.ns.atexit.md +++ b/markdown/bitburner.ns.atexit.md @@ -6,7 +6,7 @@ Add callback function when the script dies -Signature: +**Signature:** ```typescript atExit(f: () => void): void; @@ -18,7 +18,7 @@ atExit(f: () => void): void; | --- | --- | --- | | f | () => void | | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.bladeburner.md b/markdown/bitburner.ns.bladeburner.md index 77ab1fef7..c7d12efe7 100644 --- a/markdown/bitburner.ns.bladeburner.md +++ b/markdown/bitburner.ns.bladeburner.md @@ -6,7 +6,7 @@ Namespace for bladeburner functions. -Signature: +**Signature:** ```typescript readonly bladeburner: Bladeburner; diff --git a/markdown/bitburner.ns.brutessh.md b/markdown/bitburner.ns.brutessh.md index 071fc6854..0f99657e7 100644 --- a/markdown/bitburner.ns.brutessh.md +++ b/markdown/bitburner.ns.brutessh.md @@ -6,7 +6,7 @@ Runs BruteSSH.exe on a server. -Signature: +**Signature:** ```typescript brutessh(host: string): void; @@ -18,7 +18,7 @@ brutessh(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.clear.md b/markdown/bitburner.ns.clear.md index 263f0f969..71e502544 100644 --- a/markdown/bitburner.ns.clear.md +++ b/markdown/bitburner.ns.clear.md @@ -6,7 +6,7 @@ Clear data from a file. -Signature: +**Signature:** ```typescript clear(handle: string): void; @@ -18,7 +18,7 @@ clear(handle: string): void; | --- | --- | --- | | handle | string | Text file to clear. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.clearlog.md b/markdown/bitburner.ns.clearlog.md index 9e33e2d42..6cd2d140c 100644 --- a/markdown/bitburner.ns.clearlog.md +++ b/markdown/bitburner.ns.clearlog.md @@ -6,12 +6,12 @@ Clears the script’s logs. -Signature: +**Signature:** ```typescript clearLog(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.clearport.md b/markdown/bitburner.ns.clearport.md index 50038926f..84d44a9a8 100644 --- a/markdown/bitburner.ns.clearport.md +++ b/markdown/bitburner.ns.clearport.md @@ -6,7 +6,7 @@ Clear data from a port. -Signature: +**Signature:** ```typescript clearPort(handle: number): void; @@ -18,7 +18,7 @@ clearPort(handle: number): void; | --- | --- | --- | | handle | number | Port to clear. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.closetail.md b/markdown/bitburner.ns.closetail.md index 5db4eb00c..9e013acac 100644 --- a/markdown/bitburner.ns.closetail.md +++ b/markdown/bitburner.ns.closetail.md @@ -6,7 +6,7 @@ Close the tail window of a script. -Signature: +**Signature:** ```typescript closeTail(pid?: number): void; @@ -16,9 +16,9 @@ closeTail(pid?: number): void; | Parameter | Type | Description | | --- | --- | --- | -| pid | number | Optional. PID of the script having its tail closed. If omitted, the current script is used. | +| pid | number | _(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.codingcontract.md b/markdown/bitburner.ns.codingcontract.md index 2b4cd02cc..c9b6decd4 100644 --- a/markdown/bitburner.ns.codingcontract.md +++ b/markdown/bitburner.ns.codingcontract.md @@ -6,7 +6,7 @@ Namespace for codingcontract functions. -Signature: +**Signature:** ```typescript readonly codingcontract: CodingContract; diff --git a/markdown/bitburner.ns.corporation.md b/markdown/bitburner.ns.corporation.md index 92ffd5222..69f37cddd 100644 --- a/markdown/bitburner.ns.corporation.md +++ b/markdown/bitburner.ns.corporation.md @@ -6,7 +6,7 @@ Namespace for corporation functions. RAM cost: 1022.4 GB -Signature: +**Signature:** ```typescript readonly corporation: Corporation; diff --git a/markdown/bitburner.ns.deleteserver.md b/markdown/bitburner.ns.deleteserver.md index b4d202230..b2634328c 100644 --- a/markdown/bitburner.ns.deleteserver.md +++ b/markdown/bitburner.ns.deleteserver.md @@ -6,7 +6,7 @@ Delete a purchased server. -Signature: +**Signature:** ```typescript deleteServer(host: string): boolean; @@ -18,7 +18,7 @@ deleteServer(host: string): boolean; | --- | --- | --- | | host | string | Hostname of the server to delete. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.disablelog.md b/markdown/bitburner.ns.disablelog.md index 00ea2294d..f18b08695 100644 --- a/markdown/bitburner.ns.disablelog.md +++ b/markdown/bitburner.ns.disablelog.md @@ -6,7 +6,7 @@ Disables logging for the given function. -Signature: +**Signature:** ```typescript disableLog(fn: string): void; @@ -18,7 +18,7 @@ disableLog(fn: string): void; | --- | --- | --- | | fn | string | Name of function for which to disable logging. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.enablelog.md b/markdown/bitburner.ns.enablelog.md index 415e3a145..6c45ee335 100644 --- a/markdown/bitburner.ns.enablelog.md +++ b/markdown/bitburner.ns.enablelog.md @@ -6,7 +6,7 @@ Enable logging for a certain function. -Signature: +**Signature:** ```typescript enableLog(fn: string): void; @@ -18,7 +18,7 @@ enableLog(fn: string): void; | --- | --- | --- | | fn | string | Name of function for which to enable logging. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.enums.md b/markdown/bitburner.ns.enums.md index 8e1654518..012803ebf 100644 --- a/markdown/bitburner.ns.enums.md +++ b/markdown/bitburner.ns.enums.md @@ -4,7 +4,7 @@ ## NS.enums property -Signature: +**Signature:** ```typescript enums: NSEnums; diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md index 3aea59eca..7cd454036 100644 --- a/markdown/bitburner.ns.exec.md +++ b/markdown/bitburner.ns.exec.md @@ -6,7 +6,7 @@ Start another script on any server. -Signature: +**Signature:** ```typescript exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number; @@ -18,10 +18,10 @@ exec(script: string, host: string, numThreads?: number, ...args: (string | numbe | --- | --- | --- | | script | string | Filename of script to execute. | | host | string | Hostname of the target server on which to execute the script. | -| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. | +| numThreads | number | _(Optional)_ Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.exit.md b/markdown/bitburner.ns.exit.md index de6dd483c..c6bc44b4c 100644 --- a/markdown/bitburner.ns.exit.md +++ b/markdown/bitburner.ns.exit.md @@ -6,12 +6,12 @@ Terminates the current script immediately. -Signature: +**Signature:** ```typescript exit(): never; ``` -Returns: +**Returns:** never diff --git a/markdown/bitburner.ns.fileexists.md b/markdown/bitburner.ns.fileexists.md index 839830b48..b995a4b94 100644 --- a/markdown/bitburner.ns.fileexists.md +++ b/markdown/bitburner.ns.fileexists.md @@ -6,7 +6,7 @@ Check if a file exists. -Signature: +**Signature:** ```typescript fileExists(filename: string, host?: string): boolean; @@ -17,9 +17,9 @@ fileExists(filename: string, host?: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of file to check. | -| host | string | Host of target server. This is optional. If it is not specified then the function will use the current server as the target server. | +| host | string | _(Optional)_ Host of target server. This is optional. If it is not specified then the function will use the current server as the target server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.flags.md b/markdown/bitburner.ns.flags.md index dc2935077..532f91ff3 100644 --- a/markdown/bitburner.ns.flags.md +++ b/markdown/bitburner.ns.flags.md @@ -6,7 +6,7 @@ Parse command line flags. -Signature: +**Signature:** ```typescript flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; @@ -18,7 +18,7 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string] | --- | --- | --- | | schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | -Returns: +**Returns:** { \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] } diff --git a/markdown/bitburner.ns.formatnumber.md b/markdown/bitburner.ns.formatnumber.md new file mode 100644 index 000000000..68bfabb26 --- /dev/null +++ b/markdown/bitburner.ns.formatnumber.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formatNumber](./bitburner.ns.formatnumber.md) + +## NS.formatNumber() method + +Format a number. + +**Signature:** + +```typescript +formatNumber(n: number, fractionalDigits?: number, suffixStart?: number, isInteger?: boolean): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | Number to format. | +| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3. | +| suffixStart | number | _(Optional)_ How high a number must be before a suffix will be added. Optional, defaults to 1000. | +| isInteger | boolean | _(Optional)_ Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false. | + +**Returns:** + +string + +Formatted number. + +## Remarks + +RAM cost: 0 GB + +Converts a number into a numeric string with the specified format options. This is the same function that the game itself uses to display numbers. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format ram or percentages, see [formatRam](./bitburner.ns.formatram.md) and [formatPercent](./bitburner.ns.formatpercent.md) + diff --git a/markdown/bitburner.ns.formatpercent.md b/markdown/bitburner.ns.formatpercent.md new file mode 100644 index 000000000..0b09af1a3 --- /dev/null +++ b/markdown/bitburner.ns.formatpercent.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formatPercent](./bitburner.ns.formatpercent.md) + +## NS.formatPercent() method + +Format a number as a percentage. + +**Signature:** + +```typescript +formatPercent(n: number, fractionalDigits?: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | Number to format as a percentage. | +| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. | + +**Returns:** + +string + +Formatted percentage. + +## Remarks + +RAM cost: 0 GB + +Converts a number into a percentage string with the specified number of fractional digits. This is the same function that the game itself uses to display percentages. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format plain numbers or ram, see [formatNumber](./bitburner.ns.formatnumber.md) and [formatRam](./bitburner.ns.formatram.md) + diff --git a/markdown/bitburner.ns.formatram.md b/markdown/bitburner.ns.formatram.md new file mode 100644 index 000000000..d5b0ae71d --- /dev/null +++ b/markdown/bitburner.ns.formatram.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formatRam](./bitburner.ns.formatram.md) + +## NS.formatRam() method + +Format a number as an amount of ram. + +**Signature:** + +```typescript +formatRam(n: number, fractionalDigits?: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set). | +| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. | + +**Returns:** + +string + +Formatted ram amount. + +## Remarks + +RAM cost: 0 GB + +Converts a number into a ram string with the specified number of fractional digits. This is the same function that the game itself uses to display ram. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format plain numbers or percentages, see [formatNumber](./bitburner.ns.formatnumber.md) and [formatPercent](./bitburner.ns.formatpercent.md) + diff --git a/markdown/bitburner.ns.formulas.md b/markdown/bitburner.ns.formulas.md index 0d7de9755..4b4a88efa 100644 --- a/markdown/bitburner.ns.formulas.md +++ b/markdown/bitburner.ns.formulas.md @@ -6,7 +6,7 @@ Namespace for formulas functions. -Signature: +**Signature:** ```typescript readonly formulas: Formulas; diff --git a/markdown/bitburner.ns.ftpcrack.md b/markdown/bitburner.ns.ftpcrack.md index 27b58dc53..3b6c3abad 100644 --- a/markdown/bitburner.ns.ftpcrack.md +++ b/markdown/bitburner.ns.ftpcrack.md @@ -6,7 +6,7 @@ Runs FTPCrack.exe on a server. -Signature: +**Signature:** ```typescript ftpcrack(host: string): void; @@ -18,7 +18,7 @@ ftpcrack(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.gang.md b/markdown/bitburner.ns.gang.md index b9c0918bc..a72442ec7 100644 --- a/markdown/bitburner.ns.gang.md +++ b/markdown/bitburner.ns.gang.md @@ -6,7 +6,7 @@ Namespace for gang functions. -Signature: +**Signature:** ```typescript readonly gang: Gang; diff --git a/markdown/bitburner.ns.getbitnodemultipliers.md b/markdown/bitburner.ns.getbitnodemultipliers.md index f08055cb0..334400295 100644 --- a/markdown/bitburner.ns.getbitnodemultipliers.md +++ b/markdown/bitburner.ns.getbitnodemultipliers.md @@ -6,7 +6,7 @@ Get the current Bitnode multipliers. -Signature: +**Signature:** ```typescript getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers; @@ -16,10 +16,10 @@ getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers; | Parameter | Type | Description | | --- | --- | --- | -| n | number | | -| lvl | number | | +| n | number | _(Optional)_ | +| lvl | number | _(Optional)_ | -Returns: +**Returns:** [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) diff --git a/markdown/bitburner.ns.getfavortodonate.md b/markdown/bitburner.ns.getfavortodonate.md index 0d4ac030b..44faf5531 100644 --- a/markdown/bitburner.ns.getfavortodonate.md +++ b/markdown/bitburner.ns.getfavortodonate.md @@ -6,12 +6,12 @@ Returns the amount of Faction favor required to be able to donate to a faction. -Signature: +**Signature:** ```typescript getFavorToDonate(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getgrowtime.md b/markdown/bitburner.ns.getgrowtime.md index 0944be815..2a39a5cdf 100644 --- a/markdown/bitburner.ns.getgrowtime.md +++ b/markdown/bitburner.ns.getgrowtime.md @@ -6,7 +6,7 @@ Get the execution time of a grow() call. -Signature: +**Signature:** ```typescript getGrowTime(host: string): number; @@ -18,7 +18,7 @@ getGrowTime(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gethackinglevel.md b/markdown/bitburner.ns.gethackinglevel.md index 2499e349c..c3b277b62 100644 --- a/markdown/bitburner.ns.gethackinglevel.md +++ b/markdown/bitburner.ns.gethackinglevel.md @@ -6,12 +6,12 @@ Returns the player’s current hacking level. -Signature: +**Signature:** ```typescript getHackingLevel(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gethackingmultipliers.md b/markdown/bitburner.ns.gethackingmultipliers.md index 9a8be05f2..cbe41431e 100644 --- a/markdown/bitburner.ns.gethackingmultipliers.md +++ b/markdown/bitburner.ns.gethackingmultipliers.md @@ -6,12 +6,12 @@ Get hacking related multipliers. -Signature: +**Signature:** ```typescript getHackingMultipliers(): HackingMultipliers; ``` -Returns: +**Returns:** [HackingMultipliers](./bitburner.hackingmultipliers.md) diff --git a/markdown/bitburner.ns.gethacknetmultipliers.md b/markdown/bitburner.ns.gethacknetmultipliers.md index 8deeba51f..854c29046 100644 --- a/markdown/bitburner.ns.gethacknetmultipliers.md +++ b/markdown/bitburner.ns.gethacknetmultipliers.md @@ -6,12 +6,12 @@ Get hacknet related multipliers. -Signature: +**Signature:** ```typescript getHacknetMultipliers(): HacknetMultipliers; ``` -Returns: +**Returns:** [HacknetMultipliers](./bitburner.hacknetmultipliers.md) diff --git a/markdown/bitburner.ns.gethacktime.md b/markdown/bitburner.ns.gethacktime.md index 4a7a6a2f1..ca4a508d4 100644 --- a/markdown/bitburner.ns.gethacktime.md +++ b/markdown/bitburner.ns.gethacktime.md @@ -6,7 +6,7 @@ Get the execution time of a hack() call. -Signature: +**Signature:** ```typescript getHackTime(host: string): number; @@ -18,7 +18,7 @@ getHackTime(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gethostname.md b/markdown/bitburner.ns.gethostname.md index c61dab7b6..666abfe77 100644 --- a/markdown/bitburner.ns.gethostname.md +++ b/markdown/bitburner.ns.gethostname.md @@ -6,12 +6,12 @@ Returns a string with the hostname of the server that the script is running on. -Signature: +**Signature:** ```typescript getHostname(): string; ``` -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.getmoneysources.md b/markdown/bitburner.ns.getmoneysources.md index 5269f7007..8a5523666 100644 --- a/markdown/bitburner.ns.getmoneysources.md +++ b/markdown/bitburner.ns.getmoneysources.md @@ -6,12 +6,12 @@ Get information about the sources of income for this run. -Signature: +**Signature:** ```typescript getMoneySources(): MoneySources; ``` -Returns: +**Returns:** [MoneySources](./bitburner.moneysources.md) diff --git a/markdown/bitburner.ns.getplayer.md b/markdown/bitburner.ns.getplayer.md index 737a9a447..861a4e80e 100644 --- a/markdown/bitburner.ns.getplayer.md +++ b/markdown/bitburner.ns.getplayer.md @@ -6,12 +6,12 @@ Get information about the player. -Signature: +**Signature:** ```typescript getPlayer(): Player; ``` -Returns: +**Returns:** [Player](./bitburner.player.md) diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md index b448275ca..65154ffa7 100644 --- a/markdown/bitburner.ns.getporthandle.md +++ b/markdown/bitburner.ns.getporthandle.md @@ -6,7 +6,7 @@ Get all data on a port. -Signature: +**Signature:** ```typescript getPortHandle(port: number): NetscriptPort; @@ -18,7 +18,7 @@ getPortHandle(port: number): NetscriptPort; | --- | --- | --- | | port | number | Port number. Must be an integer between 1 and 20. | -Returns: +**Returns:** [NetscriptPort](./bitburner.netscriptport.md) diff --git a/markdown/bitburner.ns.getpurchasedservercost.md b/markdown/bitburner.ns.getpurchasedservercost.md index ece08176d..6389192e5 100644 --- a/markdown/bitburner.ns.getpurchasedservercost.md +++ b/markdown/bitburner.ns.getpurchasedservercost.md @@ -6,7 +6,7 @@ Get cost of purchasing a server. -Signature: +**Signature:** ```typescript getPurchasedServerCost(ram: number): number; @@ -18,7 +18,7 @@ getPurchasedServerCost(ram: number): number; | --- | --- | --- | | ram | number | Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getpurchasedserverlimit.md b/markdown/bitburner.ns.getpurchasedserverlimit.md index b4c0de297..2ba389ccd 100644 --- a/markdown/bitburner.ns.getpurchasedserverlimit.md +++ b/markdown/bitburner.ns.getpurchasedserverlimit.md @@ -6,12 +6,12 @@ Returns the maximum number of servers you can purchase. -Signature: +**Signature:** ```typescript getPurchasedServerLimit(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getpurchasedservermaxram.md b/markdown/bitburner.ns.getpurchasedservermaxram.md index d48a0ef88..8c781f5a4 100644 --- a/markdown/bitburner.ns.getpurchasedservermaxram.md +++ b/markdown/bitburner.ns.getpurchasedservermaxram.md @@ -6,12 +6,12 @@ Returns the maximum RAM that a purchased server can have. -Signature: +**Signature:** ```typescript getPurchasedServerMaxRam(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getpurchasedservers.md b/markdown/bitburner.ns.getpurchasedservers.md index 3117ef93c..2dcaa5cb4 100644 --- a/markdown/bitburner.ns.getpurchasedservers.md +++ b/markdown/bitburner.ns.getpurchasedservers.md @@ -6,12 +6,12 @@ Returns an array with the hostnames of all of the servers you have purchased. -Signature: +**Signature:** ```typescript getPurchasedServers(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.ns.getpurchasedserverupgradecost.md b/markdown/bitburner.ns.getpurchasedserverupgradecost.md index f00891b60..5d99b17ac 100644 --- a/markdown/bitburner.ns.getpurchasedserverupgradecost.md +++ b/markdown/bitburner.ns.getpurchasedserverupgradecost.md @@ -6,7 +6,7 @@ Get cost of upgrading a purchased server to the given ram. -Signature: +**Signature:** ```typescript getPurchasedServerUpgradeCost(hostname: string, ram: number): number; @@ -19,7 +19,7 @@ getPurchasedServerUpgradeCost(hostname: string, ram: number): number; | hostname | string | Hostname of the server to upgrade. | | ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getrecentscripts.md b/markdown/bitburner.ns.getrecentscripts.md index d02afe86c..4caf196f1 100644 --- a/markdown/bitburner.ns.getrecentscripts.md +++ b/markdown/bitburner.ns.getrecentscripts.md @@ -6,12 +6,12 @@ Get an array of recently killed scripts across all servers. -Signature: +**Signature:** ```typescript getRecentScripts(): RecentScript[]; ``` -Returns: +**Returns:** [RecentScript](./bitburner.recentscript.md)\[\] diff --git a/markdown/bitburner.ns.getrunningscript.md b/markdown/bitburner.ns.getrunningscript.md index dc7488f17..52d9dcd26 100644 --- a/markdown/bitburner.ns.getrunningscript.md +++ b/markdown/bitburner.ns.getrunningscript.md @@ -6,7 +6,7 @@ Get general info about a running script. -Signature: +**Signature:** ```typescript getRunningScript( @@ -20,11 +20,11 @@ getRunningScript( | Parameter | Type | Description | | --- | --- | --- | -| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. | -| hostname | string | Optional. Name of host server the script is running on. | +| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script. | +| hostname | string | _(Optional)_ Optional. Name of host server the script is running on. | | args | (string \| number \| boolean)\[\] | Arguments to identify the script | -Returns: +**Returns:** [RunningScript](./bitburner.runningscript.md) \| null diff --git a/markdown/bitburner.ns.getscriptexpgain.md b/markdown/bitburner.ns.getscriptexpgain.md index 0e4baa4f3..682b5cc40 100644 --- a/markdown/bitburner.ns.getscriptexpgain.md +++ b/markdown/bitburner.ns.getscriptexpgain.md @@ -6,7 +6,7 @@ Get the exp gain of a script. -Signature: +**Signature:** ```typescript getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number; @@ -20,7 +20,7 @@ getScriptExpGain(script: string, host: string, ...args: (string | number | boole | host | string | Server on which script is running. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getscriptincome.md b/markdown/bitburner.ns.getscriptincome.md index 8d226d597..ad6a53f01 100644 --- a/markdown/bitburner.ns.getscriptincome.md +++ b/markdown/bitburner.ns.getscriptincome.md @@ -6,7 +6,7 @@ Get the income of a script. -Signature: +**Signature:** ```typescript getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number; @@ -20,7 +20,7 @@ getScriptIncome(script: string, host: string, ...args: (string | number | boolea | host | string | Server on which script is running. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getscriptlogs.md b/markdown/bitburner.ns.getscriptlogs.md index 54c4058e7..5a512957a 100644 --- a/markdown/bitburner.ns.getscriptlogs.md +++ b/markdown/bitburner.ns.getscriptlogs.md @@ -6,7 +6,7 @@ Get all the logs of a script. -Signature: +**Signature:** ```typescript getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[]; @@ -16,11 +16,11 @@ getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[] | Parameter | Type | Description | | --- | --- | --- | -| fn | string | Optional. Filename of script to get logs from. | -| host | string | Optional. Hostname of the server that the script is on. | +| fn | string | _(Optional)_ Optional. Filename of script to get logs from. | +| host | string | _(Optional)_ Optional. Hostname of the server that the script is on. | | args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.ns.getscriptname.md b/markdown/bitburner.ns.getscriptname.md index 99566c884..419e25c6e 100644 --- a/markdown/bitburner.ns.getscriptname.md +++ b/markdown/bitburner.ns.getscriptname.md @@ -6,12 +6,12 @@ Returns the current script name. -Signature: +**Signature:** ```typescript getScriptName(): string; ``` -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md index 98761bb1a..abfc4fd2b 100644 --- a/markdown/bitburner.ns.getscriptram.md +++ b/markdown/bitburner.ns.getscriptram.md @@ -6,7 +6,7 @@ Get the ram cost of a script. -Signature: +**Signature:** ```typescript getScriptRam(script: string, host?: string): number; @@ -17,9 +17,9 @@ getScriptRam(script: string, host?: string): number; | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script. This is case-sensitive. | -| host | string | Hostname of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server. | +| host | string | _(Optional)_ Hostname of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getserver.md b/markdown/bitburner.ns.getserver.md index 95d130658..5f6af7975 100644 --- a/markdown/bitburner.ns.getserver.md +++ b/markdown/bitburner.ns.getserver.md @@ -6,7 +6,7 @@ Returns a server object for the given server. Defaults to the running script's server if host is not specified. -Signature: +**Signature:** ```typescript getServer(host?: string): Server; @@ -16,9 +16,9 @@ getServer(host?: string): Server; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Optional. Hostname for the requested server object. | +| host | string | _(Optional)_ Optional. Hostname for the requested server object. | -Returns: +**Returns:** [Server](./bitburner.server.md) diff --git a/markdown/bitburner.ns.getserverbasesecuritylevel.md b/markdown/bitburner.ns.getserverbasesecuritylevel.md index 14394b32e..b565079ed 100644 --- a/markdown/bitburner.ns.getserverbasesecuritylevel.md +++ b/markdown/bitburner.ns.getserverbasesecuritylevel.md @@ -9,7 +9,7 @@ > useless > -Signature: +**Signature:** ```typescript getServerBaseSecurityLevel(host: string): number; @@ -21,7 +21,7 @@ getServerBaseSecurityLevel(host: string): number; | --- | --- | --- | | host | string | Host of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getservergrowth.md b/markdown/bitburner.ns.getservergrowth.md index cd6d5a355..faf4eef7a 100644 --- a/markdown/bitburner.ns.getservergrowth.md +++ b/markdown/bitburner.ns.getservergrowth.md @@ -6,7 +6,7 @@ Get a server growth parameter. -Signature: +**Signature:** ```typescript getServerGrowth(host: string): number; @@ -18,7 +18,7 @@ getServerGrowth(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getservermaxmoney.md b/markdown/bitburner.ns.getservermaxmoney.md index 2dc71c4d6..2f581ca6c 100644 --- a/markdown/bitburner.ns.getservermaxmoney.md +++ b/markdown/bitburner.ns.getservermaxmoney.md @@ -6,7 +6,7 @@ Get the maximum money available on a server. -Signature: +**Signature:** ```typescript getServerMaxMoney(host: string): number; @@ -18,7 +18,7 @@ getServerMaxMoney(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getservermaxram.md b/markdown/bitburner.ns.getservermaxram.md index 63a7872c2..988657733 100644 --- a/markdown/bitburner.ns.getservermaxram.md +++ b/markdown/bitburner.ns.getservermaxram.md @@ -6,7 +6,7 @@ Get the maximum amount of RAM on a server. -Signature: +**Signature:** ```typescript getServerMaxRam(host: string): number; @@ -18,7 +18,7 @@ getServerMaxRam(host: string): number; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getserverminsecuritylevel.md b/markdown/bitburner.ns.getserverminsecuritylevel.md index cc905cbed..76cce08fd 100644 --- a/markdown/bitburner.ns.getserverminsecuritylevel.md +++ b/markdown/bitburner.ns.getserverminsecuritylevel.md @@ -6,7 +6,7 @@ Returns the minimum security level of the target server. -Signature: +**Signature:** ```typescript getServerMinSecurityLevel(host: string): number; @@ -18,7 +18,7 @@ getServerMinSecurityLevel(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getservermoneyavailable.md b/markdown/bitburner.ns.getservermoneyavailable.md index 70d824875..6d31d4d11 100644 --- a/markdown/bitburner.ns.getservermoneyavailable.md +++ b/markdown/bitburner.ns.getservermoneyavailable.md @@ -6,7 +6,7 @@ Get money available on a server. -Signature: +**Signature:** ```typescript getServerMoneyAvailable(host: string): number; @@ -18,7 +18,7 @@ getServerMoneyAvailable(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getservernumportsrequired.md b/markdown/bitburner.ns.getservernumportsrequired.md index 29def63c1..299bdbd46 100644 --- a/markdown/bitburner.ns.getservernumportsrequired.md +++ b/markdown/bitburner.ns.getservernumportsrequired.md @@ -6,7 +6,7 @@ Returns the number of open ports required to successfully run NUKE.exe on the specified server. -Signature: +**Signature:** ```typescript getServerNumPortsRequired(host: string): number; @@ -18,7 +18,7 @@ getServerNumPortsRequired(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getserverrequiredhackinglevel.md b/markdown/bitburner.ns.getserverrequiredhackinglevel.md index e5d8f24fb..24e3535fb 100644 --- a/markdown/bitburner.ns.getserverrequiredhackinglevel.md +++ b/markdown/bitburner.ns.getserverrequiredhackinglevel.md @@ -6,7 +6,7 @@ Returns the required hacking level of the target server. -Signature: +**Signature:** ```typescript getServerRequiredHackingLevel(host: string): number; @@ -18,7 +18,7 @@ getServerRequiredHackingLevel(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getserversecuritylevel.md b/markdown/bitburner.ns.getserversecuritylevel.md index 190028a91..4a3853fe7 100644 --- a/markdown/bitburner.ns.getserversecuritylevel.md +++ b/markdown/bitburner.ns.getserversecuritylevel.md @@ -6,7 +6,7 @@ Get server security level. -Signature: +**Signature:** ```typescript getServerSecurityLevel(host: string): number; @@ -18,7 +18,7 @@ getServerSecurityLevel(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getserverusedram.md b/markdown/bitburner.ns.getserverusedram.md index ab97cce0c..192d55bcf 100644 --- a/markdown/bitburner.ns.getserverusedram.md +++ b/markdown/bitburner.ns.getserverusedram.md @@ -6,7 +6,7 @@ Get the used RAM on a server. -Signature: +**Signature:** ```typescript getServerUsedRam(host: string): number; @@ -18,7 +18,7 @@ getServerUsedRam(host: string): number; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.getsharepower.md b/markdown/bitburner.ns.getsharepower.md index d615c728f..932d4bfb6 100644 --- a/markdown/bitburner.ns.getsharepower.md +++ b/markdown/bitburner.ns.getsharepower.md @@ -6,12 +6,12 @@ Calculate your share power. Based on all the active share calls. -Signature: +**Signature:** ```typescript getSharePower(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gettimesincelastaug.md b/markdown/bitburner.ns.gettimesincelastaug.md index 8b5fdd543..8b490176c 100644 --- a/markdown/bitburner.ns.gettimesincelastaug.md +++ b/markdown/bitburner.ns.gettimesincelastaug.md @@ -6,12 +6,12 @@ Returns the amount of time in milliseconds that have passed since you last installed Augmentations. -Signature: +**Signature:** ```typescript getTimeSinceLastAug(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gettotalscriptexpgain.md b/markdown/bitburner.ns.gettotalscriptexpgain.md index b89cf93d5..e89e71ef4 100644 --- a/markdown/bitburner.ns.gettotalscriptexpgain.md +++ b/markdown/bitburner.ns.gettotalscriptexpgain.md @@ -6,12 +6,12 @@ Get the exp gain of all scripts. -Signature: +**Signature:** ```typescript getTotalScriptExpGain(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.gettotalscriptincome.md b/markdown/bitburner.ns.gettotalscriptincome.md index 211904263..28bfe7ec6 100644 --- a/markdown/bitburner.ns.gettotalscriptincome.md +++ b/markdown/bitburner.ns.gettotalscriptincome.md @@ -6,12 +6,12 @@ Get the income of all scripts. -Signature: +**Signature:** ```typescript getTotalScriptIncome(): [number, number]; ``` -Returns: +**Returns:** \[number, number\] diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md index abf6567fc..896185287 100644 --- a/markdown/bitburner.ns.getweakentime.md +++ b/markdown/bitburner.ns.getweakentime.md @@ -6,7 +6,7 @@ Get the execution time of a weaken() call. -Signature: +**Signature:** ```typescript getWeakenTime(host: string): number; @@ -18,7 +18,7 @@ getWeakenTime(host: string): number; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.grafting.md b/markdown/bitburner.ns.grafting.md index ef2cafa5d..7c7bdbf6d 100644 --- a/markdown/bitburner.ns.grafting.md +++ b/markdown/bitburner.ns.grafting.md @@ -6,7 +6,7 @@ Namespace for grafting functions. -Signature: +**Signature:** ```typescript readonly grafting: Grafting; diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md index d87cb049e..5cb3182a9 100644 --- a/markdown/bitburner.ns.grow.md +++ b/markdown/bitburner.ns.grow.md @@ -6,7 +6,7 @@ Spoof money in a server's bank account, increasing the amount available. -Signature: +**Signature:** ```typescript grow(host: string, opts?: BasicHGWOptions): Promise; @@ -17,9 +17,9 @@ grow(host: string, opts?: BasicHGWOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | | host | string | Hostname of the target server to grow. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | -Returns: +**Returns:** Promise<number> diff --git a/markdown/bitburner.ns.growthanalyze.md b/markdown/bitburner.ns.growthanalyze.md index 7644fd058..6cc5d4c14 100644 --- a/markdown/bitburner.ns.growthanalyze.md +++ b/markdown/bitburner.ns.growthanalyze.md @@ -6,7 +6,7 @@ Calculate the number of grow threads needed to grow a server by a certain multiplier. -Signature: +**Signature:** ```typescript growthAnalyze(host: string, growthAmount: number, cores?: number): number; @@ -18,9 +18,9 @@ growthAnalyze(host: string, growthAmount: number, cores?: number): number; | --- | --- | --- | | host | string | Hostname of the target server. | | growthAmount | number | Multiplicative factor by which the server is grown. Decimal form. | -| cores | number | | +| cores | number | _(Optional)_ | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.growthanalyzesecurity.md b/markdown/bitburner.ns.growthanalyzesecurity.md index 367986b37..8ca794a5a 100644 --- a/markdown/bitburner.ns.growthanalyzesecurity.md +++ b/markdown/bitburner.ns.growthanalyzesecurity.md @@ -6,7 +6,7 @@ Calculate the security increase for a number of threads. -Signature: +**Signature:** ```typescript growthAnalyzeSecurity(threads: number, hostname?: string, cores?: number): number; @@ -17,10 +17,10 @@ growthAnalyzeSecurity(threads: number, hostname?: string, cores?: number): numbe | Parameter | Type | Description | | --- | --- | --- | | threads | number | Amount of threads that will be used. | -| hostname | string | Optional. Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. | -| cores | number | Optional. The number of cores of the server that would run grow. | +| hostname | string | _(Optional)_ Optional. Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. | +| cores | number | _(Optional)_ Optional. The number of cores of the server that would run grow. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md index 93de34b32..1a9b86f8f 100644 --- a/markdown/bitburner.ns.hack.md +++ b/markdown/bitburner.ns.hack.md @@ -6,7 +6,7 @@ Steal a server's money. -Signature: +**Signature:** ```typescript hack(host: string, opts?: BasicHGWOptions): Promise; @@ -17,9 +17,9 @@ hack(host: string, opts?: BasicHGWOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | | host | string | Hostname of the target server to hack. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | -Returns: +**Returns:** Promise<number> diff --git a/markdown/bitburner.ns.hackanalyze.md b/markdown/bitburner.ns.hackanalyze.md index 51499edb1..ea0d098fc 100644 --- a/markdown/bitburner.ns.hackanalyze.md +++ b/markdown/bitburner.ns.hackanalyze.md @@ -6,7 +6,7 @@ Get the part of money stolen with a single thread. -Signature: +**Signature:** ```typescript hackAnalyze(host: string): number; @@ -18,7 +18,7 @@ hackAnalyze(host: string): number; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.hackanalyzechance.md b/markdown/bitburner.ns.hackanalyzechance.md index 123adf014..3fd969053 100644 --- a/markdown/bitburner.ns.hackanalyzechance.md +++ b/markdown/bitburner.ns.hackanalyzechance.md @@ -6,7 +6,7 @@ Get the chance of successfully hacking a server. -Signature: +**Signature:** ```typescript hackAnalyzeChance(host: string): number; @@ -18,7 +18,7 @@ hackAnalyzeChance(host: string): number; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.hackanalyzesecurity.md b/markdown/bitburner.ns.hackanalyzesecurity.md index f25b4c663..5d2505a50 100644 --- a/markdown/bitburner.ns.hackanalyzesecurity.md +++ b/markdown/bitburner.ns.hackanalyzesecurity.md @@ -6,7 +6,7 @@ Get the security increase for a number of threads. -Signature: +**Signature:** ```typescript hackAnalyzeSecurity(threads: number, hostname?: string): number; @@ -17,9 +17,9 @@ hackAnalyzeSecurity(threads: number, hostname?: string): number; | Parameter | Type | Description | | --- | --- | --- | | threads | number | Amount of threads that will be used. | -| hostname | string | Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. | +| hostname | string | _(Optional)_ Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md index ef07429c2..3a1cf7c25 100644 --- a/markdown/bitburner.ns.hackanalyzethreads.md +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -6,7 +6,7 @@ Predict the effect of hack. -Signature: +**Signature:** ```typescript hackAnalyzeThreads(host: string, hackAmount: number): number; @@ -19,7 +19,7 @@ hackAnalyzeThreads(host: string, hackAmount: number): number; | host | string | Hostname of the target server to analyze. | | hackAmount | number | Amount of money you want to hack from the server. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.hacknet.md b/markdown/bitburner.ns.hacknet.md index d4413dc59..7d211408b 100644 --- a/markdown/bitburner.ns.hacknet.md +++ b/markdown/bitburner.ns.hacknet.md @@ -6,7 +6,7 @@ Namespace for hacknet functions. -Signature: +**Signature:** ```typescript readonly hacknet: Hacknet; diff --git a/markdown/bitburner.ns.hasrootaccess.md b/markdown/bitburner.ns.hasrootaccess.md index ca25dd0f8..d6573595b 100644 --- a/markdown/bitburner.ns.hasrootaccess.md +++ b/markdown/bitburner.ns.hasrootaccess.md @@ -6,7 +6,7 @@ Check if you have root access on a server. -Signature: +**Signature:** ```typescript hasRootAccess(host: string): boolean; @@ -18,7 +18,7 @@ hasRootAccess(host: string): boolean; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.hastorrouter.md b/markdown/bitburner.ns.hastorrouter.md index 9bc5a4e2f..6b54a42bc 100644 --- a/markdown/bitburner.ns.hastorrouter.md +++ b/markdown/bitburner.ns.hastorrouter.md @@ -6,12 +6,12 @@ Returns whether the player has access to the darkweb. -Signature: +**Signature:** ```typescript hasTorRouter(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.httpworm.md b/markdown/bitburner.ns.httpworm.md index 1d8c3f154..f32262fc6 100644 --- a/markdown/bitburner.ns.httpworm.md +++ b/markdown/bitburner.ns.httpworm.md @@ -6,7 +6,7 @@ Runs HTTPWorm.exe on a server. -Signature: +**Signature:** ```typescript httpworm(host: string): void; @@ -18,7 +18,7 @@ httpworm(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.infiltration.md b/markdown/bitburner.ns.infiltration.md index 009fb148e..69c510826 100644 --- a/markdown/bitburner.ns.infiltration.md +++ b/markdown/bitburner.ns.infiltration.md @@ -6,7 +6,7 @@ Namespace for infiltration functions. RAM cost: 0 GB -Signature: +**Signature:** ```typescript readonly infiltration: Infiltration; diff --git a/markdown/bitburner.ns.islogenabled.md b/markdown/bitburner.ns.islogenabled.md index 6ae575e63..80eebe130 100644 --- a/markdown/bitburner.ns.islogenabled.md +++ b/markdown/bitburner.ns.islogenabled.md @@ -6,7 +6,7 @@ Checks the status of the logging for the given function. -Signature: +**Signature:** ```typescript isLogEnabled(fn: string): boolean; @@ -18,7 +18,7 @@ isLogEnabled(fn: string): boolean; | --- | --- | --- | | fn | string | Name of function to check. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md index d26a5d83b..584dd317b 100644 --- a/markdown/bitburner.ns.isrunning.md +++ b/markdown/bitburner.ns.isrunning.md @@ -6,7 +6,7 @@ Check if a script is running. -Signature: +**Signature:** ```typescript isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean; @@ -17,10 +17,10 @@ isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | bool | Parameter | Type | Description | | --- | --- | --- | | script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | -| host | string | Hostname of target server. | +| host | string | _(Optional)_ Hostname of target server. | | args | (string \| number \| boolean)\[\] | Arguments to specify/identify which scripts to search for. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.kill.md b/markdown/bitburner.ns.kill.md index 0708953dd..67e3a39e5 100644 --- a/markdown/bitburner.ns.kill.md +++ b/markdown/bitburner.ns.kill.md @@ -6,7 +6,7 @@ Terminate another script. -Signature: +**Signature:** ```typescript kill(script: number): boolean; @@ -18,7 +18,7 @@ kill(script: number): boolean; | --- | --- | --- | | script | number | Filename or PID of the script to kill. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.kill_1.md b/markdown/bitburner.ns.kill_1.md index c50d38ec5..c8d25bba5 100644 --- a/markdown/bitburner.ns.kill_1.md +++ b/markdown/bitburner.ns.kill_1.md @@ -6,7 +6,7 @@ Terminate another script. -Signature: +**Signature:** ```typescript kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean; @@ -20,7 +20,7 @@ kill(script: string, host: string, ...args: (string | number | boolean)[]): bool | host | string | Hostname of the server on which to kill the script. | | args | (string \| number \| boolean)\[\] | Arguments to identify which script to kill. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.killall.md b/markdown/bitburner.ns.killall.md index f7b9cff6c..9d86eb527 100644 --- a/markdown/bitburner.ns.killall.md +++ b/markdown/bitburner.ns.killall.md @@ -6,7 +6,7 @@ Terminate all scripts on a server. -Signature: +**Signature:** ```typescript killall(host?: string, safetyguard?: boolean): boolean; @@ -16,10 +16,10 @@ killall(host?: string, safetyguard?: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | -| host | string | IP or hostname of the server on which to kill all scripts. | -| safetyguard | boolean | Skips the script that calls this function | +| host | string | _(Optional)_ IP or hostname of the server on which to kill all scripts. | +| safetyguard | boolean | _(Optional)_ Skips the script that calls this function | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.ls.md b/markdown/bitburner.ns.ls.md index 64ce4b423..16b2c4cc9 100644 --- a/markdown/bitburner.ns.ls.md +++ b/markdown/bitburner.ns.ls.md @@ -6,7 +6,7 @@ List files on a server. -Signature: +**Signature:** ```typescript ls(host: string, grep?: string): string[]; @@ -17,9 +17,9 @@ ls(host: string, grep?: string): string[]; | Parameter | Type | Description | | --- | --- | --- | | host | string | Hostname of the target server. | -| grep | string | A substring to search for in the filename. | +| grep | string | _(Optional)_ A substring to search for in the filename. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 8a17009a8..035d2b135 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -6,7 +6,7 @@ Collection of all functions passed to scripts -Signature: +**Signature:** ```typescript export interface NS @@ -22,7 +22,7 @@ export interface NS // Some related functions are gathered within a common namespace stock.getPrice(); ``` -[ns1 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html)
Basic ns2 usage example: +[ns1 in-game docs](https://bitburner-official.readthedocs.io/en/latest/netscript/netscript1.html)
Basic ns2 usage example: ```ts export async function main(ns) { @@ -34,28 +34,28 @@ export async function main(ns) { await ns.hack('n00dles'); } ``` -[ns2 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html)
+[ns2 in-game docs](https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html)
## Properties -| Property | Type | Description | -| --- | --- | --- | -| [args](./bitburner.ns.args.md) | (string \| number \| boolean)\[\] | Arguments passed into the script. | -| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | -| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | -| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 1022.4 GB | -| [enums](./bitburner.ns.enums.md) | [NSEnums](./bitburner.nsenums.md) | | -| [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | -| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | -| [grafting](./bitburner.ns.grafting.md) | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. | -| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | -| [infiltration](./bitburner.ns.infiltration.md) | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB | -| [pid](./bitburner.ns.pid.md) | number | The current script's PID | -| [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB | -| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | -| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | -| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. | -| [ui](./bitburner.ns.ui.md) | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [args](./bitburner.ns.args.md) | readonly | (string \| number \| boolean)\[\] | Arguments passed into the script. | +| [bladeburner](./bitburner.ns.bladeburner.md) | readonly | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | +| [codingcontract](./bitburner.ns.codingcontract.md) | readonly | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | +| [corporation](./bitburner.ns.corporation.md) | readonly | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 1022.4 GB | +| [enums](./bitburner.ns.enums.md) | | [NSEnums](./bitburner.nsenums.md) | | +| [formulas](./bitburner.ns.formulas.md) | readonly | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | +| [gang](./bitburner.ns.gang.md) | readonly | [Gang](./bitburner.gang.md) | Namespace for gang functions. | +| [grafting](./bitburner.ns.grafting.md) | readonly | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. | +| [hacknet](./bitburner.ns.hacknet.md) | readonly | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | +| [infiltration](./bitburner.ns.infiltration.md) | readonly | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB | +| [pid](./bitburner.ns.pid.md) | readonly | number | The current script's PID | +| [singularity](./bitburner.ns.singularity.md) | readonly | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB | +| [sleeve](./bitburner.ns.sleeve.md) | readonly | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | +| [stanek](./bitburner.ns.stanek.md) | readonly | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | +| [stock](./bitburner.ns.stock.md) | readonly | [TIX](./bitburner.tix.md) | Namespace for stock functions. | +| [ui](./bitburner.ns.ui.md) | readonly | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB | ## Methods @@ -76,6 +76,9 @@ export async function main(ns) { | [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. | | [fileExists(filename, host)](./bitburner.ns.fileexists.md) | Check if a file exists. | | [flags(schema)](./bitburner.ns.flags.md) | Parse command line flags. | +| [formatNumber(n, fractionalDigits, suffixStart, isInteger)](./bitburner.ns.formatnumber.md) | Format a number. | +| [formatPercent(n, fractionalDigits)](./bitburner.ns.formatpercent.md) | Format a number as a percentage. | +| [formatRam(n, fractionalDigits)](./bitburner.ns.formatram.md) | Format a number as an amount of ram. | | [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. | | [getBitNodeMultipliers(n, lvl)](./bitburner.ns.getbitnodemultipliers.md) | Get the current Bitnode multipliers. | | [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. | @@ -135,7 +138,7 @@ export async function main(ns) { | [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. | | [moveTail(x, y, pid)](./bitburner.ns.movetail.md) | Move a tail window. | | [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | -| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number. | +| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number using the numeral library. This function is deprecated and will be removed in 2.3. | | [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | | [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. | | [print(args)](./bitburner.ns.print.md) | Prints one or more values or variables to the script’s logs. | diff --git a/markdown/bitburner.ns.movetail.md b/markdown/bitburner.ns.movetail.md index 4c2b51e0c..5c59cecf1 100644 --- a/markdown/bitburner.ns.movetail.md +++ b/markdown/bitburner.ns.movetail.md @@ -6,7 +6,7 @@ Move a tail window. -Signature: +**Signature:** ```typescript moveTail(x: number, y: number, pid?: number): void; @@ -18,9 +18,9 @@ moveTail(x: number, y: number, pid?: number): void; | --- | --- | --- | | x | number | x coordinate. | | y | number | y coordinate. | -| pid | number | Optional. PID of the script having its tail moved. If omitted, the current script is used. | +| pid | number | _(Optional)_ Optional. PID of the script having its tail moved. If omitted, the current script is used. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.mv.md b/markdown/bitburner.ns.mv.md index fb2532ab3..af2ee56b9 100644 --- a/markdown/bitburner.ns.mv.md +++ b/markdown/bitburner.ns.mv.md @@ -6,7 +6,7 @@ Move a file on the target server. -Signature: +**Signature:** ```typescript mv(host: string, source: string, destination: string): void; @@ -20,7 +20,7 @@ mv(host: string, source: string, destination: string): void; | source | string | Filename of the source file. | | destination | string | Filename of the destination file. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.nformat.md b/markdown/bitburner.ns.nformat.md index 3e69c91f4..ef7bb6fb4 100644 --- a/markdown/bitburner.ns.nformat.md +++ b/markdown/bitburner.ns.nformat.md @@ -4,9 +4,9 @@ ## NS.nFormat() method -Format a number. +Format a number using the numeral library. This function is deprecated and will be removed in 2.3. -Signature: +**Signature:** ```typescript nFormat(n: number, format: string): string; @@ -17,9 +17,9 @@ nFormat(n: number, format: string): string; | Parameter | Type | Description | | --- | --- | --- | | n | number | Number to format. | -| format | string | Formatter. | +| format | string | Formatting options. See http://numeraljs.com/\#format for valid formats. | -Returns: +**Returns:** string @@ -29,7 +29,7 @@ Formatted number. RAM cost: 0 GB -Converts a number into a string with the specified formatter. This uses the numeral.js library, so the formatters must be compatible with that. This is the same function that the game itself uses to display numbers. +Converts a number into a string with the specified format options. See http://numeraljs.com/\#format for documentation on format strings supported. -For more information, see: http://numeraljs.com/ +This function is deprecated and will be removed in 2.3. diff --git a/markdown/bitburner.ns.nuke.md b/markdown/bitburner.ns.nuke.md index 2375d3466..4eeaf9bd1 100644 --- a/markdown/bitburner.ns.nuke.md +++ b/markdown/bitburner.ns.nuke.md @@ -6,7 +6,7 @@ Runs NUKE.exe on a server. -Signature: +**Signature:** ```typescript nuke(host: string): void; @@ -18,7 +18,7 @@ nuke(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.peek.md b/markdown/bitburner.ns.peek.md index 017d79d04..a33f38b20 100644 --- a/markdown/bitburner.ns.peek.md +++ b/markdown/bitburner.ns.peek.md @@ -6,7 +6,7 @@ Get a copy of the data from a port without popping it. -Signature: +**Signature:** ```typescript peek(port: number): PortData; @@ -18,7 +18,7 @@ peek(port: number): PortData; | --- | --- | --- | | port | number | Port to peek. Must be an integer between 1 and 20. | -Returns: +**Returns:** [PortData](./bitburner.portdata.md) diff --git a/markdown/bitburner.ns.pid.md b/markdown/bitburner.ns.pid.md index d2f666a2e..ffd8a84ca 100644 --- a/markdown/bitburner.ns.pid.md +++ b/markdown/bitburner.ns.pid.md @@ -6,7 +6,7 @@ The current script's PID -Signature: +**Signature:** ```typescript readonly pid: number; diff --git a/markdown/bitburner.ns.print.md b/markdown/bitburner.ns.print.md index d8ce5a74f..221105327 100644 --- a/markdown/bitburner.ns.print.md +++ b/markdown/bitburner.ns.print.md @@ -6,7 +6,7 @@ Prints one or more values or variables to the script’s logs. -Signature: +**Signature:** ```typescript print(...args: any[]): void; @@ -18,7 +18,7 @@ print(...args: any[]): void; | --- | --- | --- | | args | any\[\] | Value(s) to be printed. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.printf.md b/markdown/bitburner.ns.printf.md index 2ca1f16c1..d65c1f2fc 100644 --- a/markdown/bitburner.ns.printf.md +++ b/markdown/bitburner.ns.printf.md @@ -6,7 +6,7 @@ Prints a formatted string to the script’s logs. -Signature: +**Signature:** ```typescript printf(format: string, ...args: any[]): void; @@ -19,7 +19,7 @@ printf(format: string, ...args: any[]): void; | format | string | Format of the message. | | args | any\[\] | Value(s) to be printed. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.prompt.md b/markdown/bitburner.ns.prompt.md index 725855444..937b77abb 100644 --- a/markdown/bitburner.ns.prompt.md +++ b/markdown/bitburner.ns.prompt.md @@ -6,7 +6,7 @@ Prompt the player with an input modal. -Signature: +**Signature:** ```typescript prompt( @@ -20,9 +20,9 @@ prompt( | Parameter | Type | Description | | --- | --- | --- | | txt | string | Text to appear in the prompt dialog box. | -| options | { type?: "boolean" \| "text" \| "select"; choices?: string\[\] } | Options to modify the prompt the player is shown. | +| options | { type?: "boolean" \| "text" \| "select"; choices?: string\[\] } | _(Optional)_ Options to modify the prompt the player is shown. | -Returns: +**Returns:** Promise<boolean \| string> diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md index 532969c20..0aaf7a867 100644 --- a/markdown/bitburner.ns.ps.md +++ b/markdown/bitburner.ns.ps.md @@ -6,7 +6,7 @@ List running scripts on a server. -Signature: +**Signature:** ```typescript ps(host?: string): ProcessInfo[]; @@ -16,9 +16,9 @@ ps(host?: string): ProcessInfo[]; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host address of the target server. If not specified, it will be the current server’s IP by default. | +| host | string | _(Optional)_ Host address of the target server. If not specified, it will be the current server’s IP by default. | -Returns: +**Returns:** [ProcessInfo](./bitburner.processinfo.md)\[\] diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md index 7f1f90087..6e81bef09 100644 --- a/markdown/bitburner.ns.purchaseserver.md +++ b/markdown/bitburner.ns.purchaseserver.md @@ -6,7 +6,7 @@ Purchase a server. -Signature: +**Signature:** ```typescript purchaseServer(hostname: string, ram: number): string; @@ -19,7 +19,7 @@ purchaseServer(hostname: string, ram: number): string; | hostname | string | Hostname of the purchased server. | | ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.read.md b/markdown/bitburner.ns.read.md index 005316929..af55f6dab 100644 --- a/markdown/bitburner.ns.read.md +++ b/markdown/bitburner.ns.read.md @@ -6,7 +6,7 @@ Read content of a file. -Signature: +**Signature:** ```typescript read(filename: string): string; @@ -18,7 +18,7 @@ read(filename: string): string; | --- | --- | --- | | filename | string | Name of the file to be read. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.readport.md b/markdown/bitburner.ns.readport.md index a6677acff..1d86dc094 100644 --- a/markdown/bitburner.ns.readport.md +++ b/markdown/bitburner.ns.readport.md @@ -6,7 +6,7 @@ Read data from a port. -Signature: +**Signature:** ```typescript readPort(port: number): PortData; @@ -18,7 +18,7 @@ readPort(port: number): PortData; | --- | --- | --- | | port | number | | -Returns: +**Returns:** [PortData](./bitburner.portdata.md) diff --git a/markdown/bitburner.ns.relaysmtp.md b/markdown/bitburner.ns.relaysmtp.md index ccbeb6016..389f7a312 100644 --- a/markdown/bitburner.ns.relaysmtp.md +++ b/markdown/bitburner.ns.relaysmtp.md @@ -6,7 +6,7 @@ Runs relaySMTP.exe on a server. -Signature: +**Signature:** ```typescript relaysmtp(host: string): void; @@ -18,7 +18,7 @@ relaysmtp(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.renamepurchasedserver.md b/markdown/bitburner.ns.renamepurchasedserver.md index 9a0b74f83..9538662f6 100644 --- a/markdown/bitburner.ns.renamepurchasedserver.md +++ b/markdown/bitburner.ns.renamepurchasedserver.md @@ -6,7 +6,7 @@ Rename a purchased server. -Signature: +**Signature:** ```typescript renamePurchasedServer(hostname: string, newName: string): boolean; @@ -19,7 +19,7 @@ renamePurchasedServer(hostname: string, newName: string): boolean; | hostname | string | Current server hostname. | | newName | string | New server hostname. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.resizetail.md b/markdown/bitburner.ns.resizetail.md index 0c606780d..e0f47959a 100644 --- a/markdown/bitburner.ns.resizetail.md +++ b/markdown/bitburner.ns.resizetail.md @@ -6,7 +6,7 @@ Resize a tail window. -Signature: +**Signature:** ```typescript resizeTail(width: number, height: number, pid?: number): void; @@ -18,9 +18,9 @@ resizeTail(width: number, height: number, pid?: number): void; | --- | --- | --- | | width | number | Width of the window. | | height | number | Height of the window. | -| pid | number | Optional. PID of the script having its tail resized. If omitted, the current script is used. | +| pid | number | _(Optional)_ Optional. PID of the script having its tail resized. If omitted, the current script is used. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.rm.md b/markdown/bitburner.ns.rm.md index 56621f077..c39b74885 100644 --- a/markdown/bitburner.ns.rm.md +++ b/markdown/bitburner.ns.rm.md @@ -6,7 +6,7 @@ Delete a file. -Signature: +**Signature:** ```typescript rm(name: string, host?: string): boolean; @@ -17,9 +17,9 @@ rm(name: string, host?: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | name | string | Filename of file to remove. Must include the extension. | -| host | string | Hostname of the server on which to delete the file. Optional. Defaults to current server. | +| host | string | _(Optional)_ Hostname of the server on which to delete the file. Optional. Defaults to current server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md index 842d46bca..7c0ed432c 100644 --- a/markdown/bitburner.ns.run.md +++ b/markdown/bitburner.ns.run.md @@ -6,7 +6,7 @@ Start another script on the current server. -Signature: +**Signature:** ```typescript run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number; @@ -17,10 +17,10 @@ run(script: string, numThreads?: number, ...args: (string | number | boolean)[]) | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script to run. | -| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | +| numThreads | number | _(Optional)_ Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.scan.md b/markdown/bitburner.ns.scan.md index a51c1886b..8a7e2fc9f 100644 --- a/markdown/bitburner.ns.scan.md +++ b/markdown/bitburner.ns.scan.md @@ -6,7 +6,7 @@ Get the list of servers connected to a server. -Signature: +**Signature:** ```typescript scan(host?: string): string[]; @@ -16,9 +16,9 @@ scan(host?: string): string[]; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Optional. Hostname of the server to scan, default to current server. | +| host | string | _(Optional)_ Optional. Hostname of the server to scan, default to current server. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md index 8bd95155e..b8dd1d685 100644 --- a/markdown/bitburner.ns.scp.md +++ b/markdown/bitburner.ns.scp.md @@ -6,7 +6,7 @@ Copy file between servers. -Signature: +**Signature:** ```typescript scp(files: string | string[], destination: string, source?: string): boolean; @@ -18,9 +18,9 @@ scp(files: string | string[], destination: string, source?: string): boolean; | --- | --- | --- | | files | string \| string\[\] | Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading /. | | destination | string | Hostname of the destination server, which is the server to which the file will be copied. | -| source | string | Hostname 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. | +| source | string | _(Optional)_ Hostname 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. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.scriptkill.md b/markdown/bitburner.ns.scriptkill.md index 639f930be..d256b2e12 100644 --- a/markdown/bitburner.ns.scriptkill.md +++ b/markdown/bitburner.ns.scriptkill.md @@ -6,7 +6,7 @@ Kill all scripts with a filename. -Signature: +**Signature:** ```typescript scriptKill(script: string, host: string): boolean; @@ -19,7 +19,7 @@ scriptKill(script: string, host: string): boolean; | script | string | Filename of script to kill. This is case-sensitive. | | host | string | Hostname of target server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.scriptrunning.md b/markdown/bitburner.ns.scriptrunning.md index 46e107478..8c2a64a00 100644 --- a/markdown/bitburner.ns.scriptrunning.md +++ b/markdown/bitburner.ns.scriptrunning.md @@ -6,7 +6,7 @@ Check if any script with a filename is running. -Signature: +**Signature:** ```typescript scriptRunning(script: string, host: string): boolean; @@ -19,7 +19,7 @@ scriptRunning(script: string, host: string): boolean; | script | string | Filename of script to check. This is case-sensitive. | | host | string | Hostname of target server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.serverexists.md b/markdown/bitburner.ns.serverexists.md index 1f9c2cee7..2f287a41a 100644 --- a/markdown/bitburner.ns.serverexists.md +++ b/markdown/bitburner.ns.serverexists.md @@ -6,7 +6,7 @@ Returns a boolean denoting whether or not the specified server exists. -Signature: +**Signature:** ```typescript serverExists(host: string): boolean; @@ -18,7 +18,7 @@ serverExists(host: string): boolean; | --- | --- | --- | | host | string | Hostname of target server. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.share.md b/markdown/bitburner.ns.share.md index 421e3e032..b308966f5 100644 --- a/markdown/bitburner.ns.share.md +++ b/markdown/bitburner.ns.share.md @@ -6,12 +6,12 @@ Share your computer with your factions. -Signature: +**Signature:** ```typescript share(): Promise; ``` -Returns: +**Returns:** Promise<void> @@ -19,5 +19,5 @@ Promise<void> RAM cost: 2.4 GB -Increases your rep gain of hacking contracts while share is called. Scales with thread count. +Increases your rep gain of all faction work types while share is called. Scales with thread count. diff --git a/markdown/bitburner.ns.singularity.md b/markdown/bitburner.ns.singularity.md index 23f31db42..3dd1ca02d 100644 --- a/markdown/bitburner.ns.singularity.md +++ b/markdown/bitburner.ns.singularity.md @@ -6,7 +6,7 @@ Namespace for singularity functions. RAM cost: 0 GB -Signature: +**Signature:** ```typescript readonly singularity: Singularity; diff --git a/markdown/bitburner.ns.sleep.md b/markdown/bitburner.ns.sleep.md index 857992f86..d3784a225 100644 --- a/markdown/bitburner.ns.sleep.md +++ b/markdown/bitburner.ns.sleep.md @@ -6,7 +6,7 @@ Suspends the script for n milliseconds. -Signature: +**Signature:** ```typescript sleep(millis: number): Promise; @@ -18,7 +18,7 @@ sleep(millis: number): Promise; | --- | --- | --- | | millis | number | Number of milliseconds to sleep. | -Returns: +**Returns:** Promise<true> diff --git a/markdown/bitburner.ns.sleeve.md b/markdown/bitburner.ns.sleeve.md index bc3be1dd9..67fb98070 100644 --- a/markdown/bitburner.ns.sleeve.md +++ b/markdown/bitburner.ns.sleeve.md @@ -6,7 +6,7 @@ Namespace for sleeve functions. -Signature: +**Signature:** ```typescript readonly sleeve: Sleeve; diff --git a/markdown/bitburner.ns.spawn.md b/markdown/bitburner.ns.spawn.md index 7596ee3a8..00b0fa557 100644 --- a/markdown/bitburner.ns.spawn.md +++ b/markdown/bitburner.ns.spawn.md @@ -6,7 +6,7 @@ Terminate current script and start another in 10 seconds. -Signature: +**Signature:** ```typescript spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void; @@ -17,10 +17,10 @@ spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[ | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script to execute. | -| numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. | +| numThreads | number | _(Optional)_ Number of threads to spawn new script with. Will be rounded to nearest integer. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md index cda063926..6912ff691 100644 --- a/markdown/bitburner.ns.sprintf.md +++ b/markdown/bitburner.ns.sprintf.md @@ -6,7 +6,7 @@ Format a string. -Signature: +**Signature:** ```typescript sprintf(format: string, ...args: any[]): string; @@ -19,7 +19,7 @@ sprintf(format: string, ...args: any[]): string; | format | string | String to format. | | args | any\[\] | Formatting arguments. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.sqlinject.md b/markdown/bitburner.ns.sqlinject.md index e5b4797cf..b1585b3fe 100644 --- a/markdown/bitburner.ns.sqlinject.md +++ b/markdown/bitburner.ns.sqlinject.md @@ -6,7 +6,7 @@ Runs SQLInject.exe on a server. -Signature: +**Signature:** ```typescript sqlinject(host: string): void; @@ -18,7 +18,7 @@ sqlinject(host: string): void; | --- | --- | --- | | host | string | Hostname of the target server. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.stanek.md b/markdown/bitburner.ns.stanek.md index b1d10e2e7..820fcf9dc 100644 --- a/markdown/bitburner.ns.stanek.md +++ b/markdown/bitburner.ns.stanek.md @@ -6,7 +6,7 @@ Namespace for stanek functions. RAM cost: 0 GB -Signature: +**Signature:** ```typescript readonly stanek: Stanek; diff --git a/markdown/bitburner.ns.stock.md b/markdown/bitburner.ns.stock.md index 14a1bc388..057e38bf7 100644 --- a/markdown/bitburner.ns.stock.md +++ b/markdown/bitburner.ns.stock.md @@ -6,7 +6,7 @@ Namespace for stock functions. -Signature: +**Signature:** ```typescript readonly stock: TIX; diff --git a/markdown/bitburner.ns.tail.md b/markdown/bitburner.ns.tail.md index 333d594af..9bf3d5035 100644 --- a/markdown/bitburner.ns.tail.md +++ b/markdown/bitburner.ns.tail.md @@ -6,7 +6,7 @@ Open the tail window of a script. -Signature: +**Signature:** ```typescript tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void; @@ -16,11 +16,11 @@ tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): | Parameter | Type | Description | | --- | --- | --- | -| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | -| host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | +| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | +| host | string | _(Optional)_ Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | | args | (string \| number \| boolean)\[\] | Arguments for the script being tailed. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.tformat.md b/markdown/bitburner.ns.tformat.md index f5b658448..54b06b02a 100644 --- a/markdown/bitburner.ns.tformat.md +++ b/markdown/bitburner.ns.tformat.md @@ -6,7 +6,7 @@ Format time to a readable string. -Signature: +**Signature:** ```typescript tFormat(milliseconds: number, milliPrecision?: boolean): string; @@ -17,9 +17,9 @@ tFormat(milliseconds: number, milliPrecision?: boolean): string; | Parameter | Type | Description | | --- | --- | --- | | milliseconds | number | Number of millisecond to format. | -| milliPrecision | boolean | Format time with subsecond precision. Defaults to false. | +| milliPrecision | boolean | _(Optional)_ Format time with subsecond precision. Defaults to false. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md index f9e801c26..00a46e530 100644 --- a/markdown/bitburner.ns.toast.md +++ b/markdown/bitburner.ns.toast.md @@ -6,7 +6,7 @@ Queue a toast (bottom-right notification). -Signature: +**Signature:** ```typescript toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void; @@ -17,10 +17,10 @@ toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | Parameter | Type | Description | | --- | --- | --- | | msg | string | Message in the toast. | -| variant | [ToastVariant](./bitburner.toastvariant.md) \| \`${[ToastVariant](./bitburner.toastvariant.md)}\` | Type of toast. Must be one of success, info, warning, error. Defaults to success. | -| duration | number \| null | Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000. | +| variant | [ToastVariant](./bitburner.toastvariant.md) \| \`${[ToastVariant](./bitburner.toastvariant.md)}\` | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. | +| duration | number \| null | _(Optional)_ Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.tprint.md b/markdown/bitburner.ns.tprint.md index 4e8cd8d8a..ccd8ea126 100644 --- a/markdown/bitburner.ns.tprint.md +++ b/markdown/bitburner.ns.tprint.md @@ -6,7 +6,7 @@ Prints one or more values or variables to the Terminal. -Signature: +**Signature:** ```typescript tprint(...args: any[]): void; @@ -18,7 +18,7 @@ tprint(...args: any[]): void; | --- | --- | --- | | args | any\[\] | Value(s) to be printed. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.tprintf.md b/markdown/bitburner.ns.tprintf.md index 1005b9be8..e05129a1d 100644 --- a/markdown/bitburner.ns.tprintf.md +++ b/markdown/bitburner.ns.tprintf.md @@ -6,7 +6,7 @@ Prints a raw value or a variable to the Terminal. -Signature: +**Signature:** ```typescript tprintf(format: string, ...values: any[]): void; @@ -19,7 +19,7 @@ tprintf(format: string, ...values: any[]): void; | format | string | Format of the message. | | values | any\[\] | Value(s) to be printed. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md index e2ea77324..7ce514a2b 100644 --- a/markdown/bitburner.ns.trywriteport.md +++ b/markdown/bitburner.ns.trywriteport.md @@ -6,7 +6,7 @@ Attempt to write to a port. -Signature: +**Signature:** ```typescript tryWritePort(port: number, data: string | number): boolean; @@ -19,7 +19,7 @@ tryWritePort(port: number, data: string | number): boolean; | port | number | Port or text file that will be written to. | | data | string \| number | Data to write. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.ui.md b/markdown/bitburner.ns.ui.md index 445717055..687f7242f 100644 --- a/markdown/bitburner.ns.ui.md +++ b/markdown/bitburner.ns.ui.md @@ -6,7 +6,7 @@ Namespace for user interface functions. RAM cost: 0 GB -Signature: +**Signature:** ```typescript readonly ui: UserInterface; diff --git a/markdown/bitburner.ns.upgradepurchasedserver.md b/markdown/bitburner.ns.upgradepurchasedserver.md index e61279b5a..d36f2e877 100644 --- a/markdown/bitburner.ns.upgradepurchasedserver.md +++ b/markdown/bitburner.ns.upgradepurchasedserver.md @@ -6,7 +6,7 @@ Upgrade a purchased server's RAM. -Signature: +**Signature:** ```typescript upgradePurchasedServer(hostname: string, ram: number): boolean; @@ -19,7 +19,7 @@ upgradePurchasedServer(hostname: string, ram: number): boolean; | hostname | string | Hostname of the server to upgrade. | | ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md index 17b4c4ae7..ef807f8ce 100644 --- a/markdown/bitburner.ns.vsprintf.md +++ b/markdown/bitburner.ns.vsprintf.md @@ -6,7 +6,7 @@ Format a string with an array of arguments. -Signature: +**Signature:** ```typescript vsprintf(format: string, args: any[]): string; @@ -19,7 +19,7 @@ vsprintf(format: string, args: any[]): string; | format | string | String to format. | | args | any\[\] | Formatting arguments. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md index 4794e9f21..d025ef8cc 100644 --- a/markdown/bitburner.ns.weaken.md +++ b/markdown/bitburner.ns.weaken.md @@ -6,7 +6,7 @@ Reduce a server's security level. -Signature: +**Signature:** ```typescript weaken(host: string, opts?: BasicHGWOptions): Promise; @@ -17,9 +17,9 @@ weaken(host: string, opts?: BasicHGWOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | | host | string | Hostname of the target server to weaken. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | -Returns: +**Returns:** Promise<number> diff --git a/markdown/bitburner.ns.weakenanalyze.md b/markdown/bitburner.ns.weakenanalyze.md index 4dabf061a..211de8bb5 100644 --- a/markdown/bitburner.ns.weakenanalyze.md +++ b/markdown/bitburner.ns.weakenanalyze.md @@ -6,7 +6,7 @@ Predict the effect of weaken. -Signature: +**Signature:** ```typescript weakenAnalyze(threads: number, cores?: number): number; @@ -17,9 +17,9 @@ weakenAnalyze(threads: number, cores?: number): number; | 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. | +| cores | number | _(Optional)_ Optional. The number of cores of the server that would run weaken. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.ns.wget.md b/markdown/bitburner.ns.wget.md index 3fa300806..4761fa669 100644 --- a/markdown/bitburner.ns.wget.md +++ b/markdown/bitburner.ns.wget.md @@ -6,7 +6,7 @@ Download a file from the internet. -Signature: +**Signature:** ```typescript wget(url: string, target: string, host?: string): Promise; @@ -18,9 +18,9 @@ wget(url: string, target: string, host?: string): Promise; | --- | --- | --- | | 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. | +| host | string | _(Optional)_ Optional hostname/ip of server for target file. | -Returns: +**Returns:** Promise<boolean> diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md index eb3a41029..85605f1df 100644 --- a/markdown/bitburner.ns.write.md +++ b/markdown/bitburner.ns.write.md @@ -6,7 +6,7 @@ Write data to a file. -Signature: +**Signature:** ```typescript write(filename: string, data?: string, mode?: "w" | "a"): void; @@ -17,10 +17,10 @@ write(filename: string, data?: string, mode?: "w" | "a"): void; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Name of the file to be written to. | -| data | string | Data to write. | -| mode | "w" \| "a" | Defines the write mode. | +| data | string | _(Optional)_ Data to write. | +| mode | "w" \| "a" | _(Optional)_ Defines the write mode. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ns.writeport.md b/markdown/bitburner.ns.writeport.md index eb98c6b2a..f1f751d45 100644 --- a/markdown/bitburner.ns.writeport.md +++ b/markdown/bitburner.ns.writeport.md @@ -6,7 +6,7 @@ Write data to a port. -Signature: +**Signature:** ```typescript writePort(port: number, data: string | number): PortData | null; @@ -19,7 +19,7 @@ writePort(port: number, data: string | number): PortData | null; | port | number | | | data | string \| number | | -Returns: +**Returns:** [PortData](./bitburner.portdata.md) \| null diff --git a/markdown/bitburner.nsenums.md b/markdown/bitburner.nsenums.md index 3324c47f6..a7dfb431b 100644 --- a/markdown/bitburner.nsenums.md +++ b/markdown/bitburner.nsenums.md @@ -5,7 +5,7 @@ ## NSEnums type -Signature: +**Signature:** ```typescript export type NSEnums = { @@ -19,5 +19,5 @@ export type NSEnums = { UniversityClassType: typeof UniversityClassType; }; ``` -References: [CityName](./bitburner.cityname.md), [CrimeType](./bitburner.crimetype.md), [FactionWorkType](./bitburner.factionworktype.md), [GymType](./bitburner.gymtype.md), [JobName](./bitburner.jobname.md), [LocationName](./bitburner.locationname.md), [ToastVariant](./bitburner.toastvariant.md), [UniversityClassType](./bitburner.universityclasstype.md) +**References:** [CityName](./bitburner.cityname.md), [CrimeType](./bitburner.crimetype.md), [FactionWorkType](./bitburner.factionworktype.md), [GymType](./bitburner.gymtype.md), [JobName](./bitburner.jobname.md), [LocationName](./bitburner.locationname.md), [ToastVariant](./bitburner.toastvariant.md), [UniversityClassType](./bitburner.universityclasstype.md) diff --git a/markdown/bitburner.office.avgene.md b/markdown/bitburner.office.avgene.md index 551fcc6e4..0ad56b7d6 100644 --- a/markdown/bitburner.office.avgene.md +++ b/markdown/bitburner.office.avgene.md @@ -6,7 +6,7 @@ Average energy of the employees -Signature: +**Signature:** ```typescript avgEne: number; diff --git a/markdown/bitburner.office.avghap.md b/markdown/bitburner.office.avghap.md index 7d9ec2855..0131d16d9 100644 --- a/markdown/bitburner.office.avghap.md +++ b/markdown/bitburner.office.avghap.md @@ -6,7 +6,7 @@ Average happiness of the employees -Signature: +**Signature:** ```typescript avgHap: number; diff --git a/markdown/bitburner.office.avgmor.md b/markdown/bitburner.office.avgmor.md index 5397ae3a8..0b0c1bf44 100644 --- a/markdown/bitburner.office.avgmor.md +++ b/markdown/bitburner.office.avgmor.md @@ -6,7 +6,7 @@ Average morale of the employees -Signature: +**Signature:** ```typescript avgMor: number; diff --git a/markdown/bitburner.office.employeejobs.md b/markdown/bitburner.office.employeejobs.md index debdb5eff..cc9be3c4c 100644 --- a/markdown/bitburner.office.employeejobs.md +++ b/markdown/bitburner.office.employeejobs.md @@ -6,7 +6,7 @@ Positions of the employees -Signature: +**Signature:** ```typescript employeeJobs: Record; diff --git a/markdown/bitburner.office.employeeprod.md b/markdown/bitburner.office.employeeprod.md index 9efcdbe6e..9d30748ab 100644 --- a/markdown/bitburner.office.employeeprod.md +++ b/markdown/bitburner.office.employeeprod.md @@ -6,7 +6,7 @@ Production of the employees -Signature: +**Signature:** ```typescript employeeProd: Record; diff --git a/markdown/bitburner.office.employees.md b/markdown/bitburner.office.employees.md index a38f423ca..28fe01312 100644 --- a/markdown/bitburner.office.employees.md +++ b/markdown/bitburner.office.employees.md @@ -6,7 +6,7 @@ Amount of employees -Signature: +**Signature:** ```typescript employees: number; diff --git a/markdown/bitburner.office.loc.md b/markdown/bitburner.office.loc.md index 4e544bd6d..5002b6357 100644 --- a/markdown/bitburner.office.loc.md +++ b/markdown/bitburner.office.loc.md @@ -6,7 +6,7 @@ City of the office -Signature: +**Signature:** ```typescript loc: CityName; diff --git a/markdown/bitburner.office.maxene.md b/markdown/bitburner.office.maxene.md index 92554bb97..081ad48a2 100644 --- a/markdown/bitburner.office.maxene.md +++ b/markdown/bitburner.office.maxene.md @@ -6,7 +6,7 @@ Maximum amount of energy of the employees -Signature: +**Signature:** ```typescript maxEne: number; diff --git a/markdown/bitburner.office.maxhap.md b/markdown/bitburner.office.maxhap.md index 03e619dec..9e62ed6da 100644 --- a/markdown/bitburner.office.maxhap.md +++ b/markdown/bitburner.office.maxhap.md @@ -6,7 +6,7 @@ Maximum happiness of the employees -Signature: +**Signature:** ```typescript maxHap: number; diff --git a/markdown/bitburner.office.maxmor.md b/markdown/bitburner.office.maxmor.md index ae0c55f3d..423a204ae 100644 --- a/markdown/bitburner.office.maxmor.md +++ b/markdown/bitburner.office.maxmor.md @@ -6,7 +6,7 @@ Maximum morale of the employees -Signature: +**Signature:** ```typescript maxMor: number; diff --git a/markdown/bitburner.office.md b/markdown/bitburner.office.md index 541512def..82553ffcb 100644 --- a/markdown/bitburner.office.md +++ b/markdown/bitburner.office.md @@ -6,7 +6,7 @@ Office for a division in a city. -Signature: +**Signature:** ```typescript export interface Office @@ -14,17 +14,17 @@ export interface Office ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [avgEne](./bitburner.office.avgene.md) | number | Average energy of the employees | -| [avgHap](./bitburner.office.avghap.md) | number | Average happiness of the employees | -| [avgMor](./bitburner.office.avgmor.md) | number | Average morale of the employees | -| [employeeJobs](./bitburner.office.employeejobs.md) | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Positions of the employees | -| [employeeProd](./bitburner.office.employeeprod.md) | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Production of the employees | -| [employees](./bitburner.office.employees.md) | number | Amount of employees | -| [loc](./bitburner.office.loc.md) | [CityName](./bitburner.cityname.md) | City of the office | -| [maxEne](./bitburner.office.maxene.md) | number | Maximum amount of energy of the employees | -| [maxHap](./bitburner.office.maxhap.md) | number | Maximum happiness of the employees | -| [maxMor](./bitburner.office.maxmor.md) | number | Maximum morale of the employees | -| [size](./bitburner.office.size.md) | number | Maximum number of employee | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [avgEne](./bitburner.office.avgene.md) | | number | Average energy of the employees | +| [avgHap](./bitburner.office.avghap.md) | | number | Average happiness of the employees | +| [avgMor](./bitburner.office.avgmor.md) | | number | Average morale of the employees | +| [employeeJobs](./bitburner.office.employeejobs.md) | | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Positions of the employees | +| [employeeProd](./bitburner.office.employeeprod.md) | | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Production of the employees | +| [employees](./bitburner.office.employees.md) | | number | Amount of employees | +| [loc](./bitburner.office.loc.md) | | [CityName](./bitburner.cityname.md) | City of the office | +| [maxEne](./bitburner.office.maxene.md) | | number | Maximum amount of energy of the employees | +| [maxHap](./bitburner.office.maxhap.md) | | number | Maximum happiness of the employees | +| [maxMor](./bitburner.office.maxmor.md) | | number | Maximum morale of the employees | +| [size](./bitburner.office.size.md) | | number | Maximum number of employee | diff --git a/markdown/bitburner.office.size.md b/markdown/bitburner.office.size.md index 696e614c0..369897e38 100644 --- a/markdown/bitburner.office.size.md +++ b/markdown/bitburner.office.size.md @@ -6,7 +6,7 @@ Maximum number of employee -Signature: +**Signature:** ```typescript size: number; diff --git a/markdown/bitburner.officeapi.buycoffee.md b/markdown/bitburner.officeapi.buycoffee.md index 337e89594..e5a4b05dc 100644 --- a/markdown/bitburner.officeapi.buycoffee.md +++ b/markdown/bitburner.officeapi.buycoffee.md @@ -6,7 +6,7 @@ Buy coffee for your employees -Signature: +**Signature:** ```typescript buyCoffee(divisionName: string, city: CityName | `${CityName}`): boolean; @@ -19,7 +19,7 @@ buyCoffee(divisionName: string, city: CityName | `${CityName}`): boolean; | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.officeapi.gethireadvertcost.md b/markdown/bitburner.officeapi.gethireadvertcost.md index 9b4a4b565..ff32ee420 100644 --- a/markdown/bitburner.officeapi.gethireadvertcost.md +++ b/markdown/bitburner.officeapi.gethireadvertcost.md @@ -6,7 +6,7 @@ Get the cost to hire AdVert. -Signature: +**Signature:** ```typescript getHireAdVertCost(divisionName: string): number; @@ -18,7 +18,7 @@ getHireAdVertCost(divisionName: string): number; | --- | --- | --- | | divisionName | string | Name of the division. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.officeapi.gethireadvertcount.md b/markdown/bitburner.officeapi.gethireadvertcount.md index 9ba4e048d..41c2e375f 100644 --- a/markdown/bitburner.officeapi.gethireadvertcount.md +++ b/markdown/bitburner.officeapi.gethireadvertcount.md @@ -6,7 +6,7 @@ Get the number of times you have hired AdVert. -Signature: +**Signature:** ```typescript getHireAdVertCount(divisionName: string): number; @@ -18,7 +18,7 @@ getHireAdVertCount(divisionName: string): number; | --- | --- | --- | | divisionName | string | Name of the division. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.officeapi.getoffice.md b/markdown/bitburner.officeapi.getoffice.md index fc2f18b67..2ba2ef7ca 100644 --- a/markdown/bitburner.officeapi.getoffice.md +++ b/markdown/bitburner.officeapi.getoffice.md @@ -6,7 +6,7 @@ Get data about an office -Signature: +**Signature:** ```typescript getOffice(divisionName: string, city: CityName | `${CityName}`): Office; @@ -19,7 +19,7 @@ getOffice(divisionName: string, city: CityName | `${CityName}`): Office; | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -Returns: +**Returns:** [Office](./bitburner.office.md) diff --git a/markdown/bitburner.officeapi.getofficesizeupgradecost.md b/markdown/bitburner.officeapi.getofficesizeupgradecost.md index 0defaf090..5e32e8e80 100644 --- a/markdown/bitburner.officeapi.getofficesizeupgradecost.md +++ b/markdown/bitburner.officeapi.getofficesizeupgradecost.md @@ -6,7 +6,7 @@ Cost to Upgrade office size. -Signature: +**Signature:** ```typescript getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, asize: number): number; @@ -20,7 +20,7 @@ getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, a | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | asize | number | | -Returns: +**Returns:** number diff --git a/markdown/bitburner.officeapi.getresearchcost.md b/markdown/bitburner.officeapi.getresearchcost.md index 14899201a..84195156f 100644 --- a/markdown/bitburner.officeapi.getresearchcost.md +++ b/markdown/bitburner.officeapi.getresearchcost.md @@ -6,7 +6,7 @@ Get the cost to unlock research -Signature: +**Signature:** ```typescript getResearchCost(divisionName: string, researchName: string): number; @@ -19,7 +19,7 @@ getResearchCost(divisionName: string, researchName: string): number; | divisionName | string | Name of the division | | researchName | string | Name of the research | -Returns: +**Returns:** number diff --git a/markdown/bitburner.officeapi.hasresearched.md b/markdown/bitburner.officeapi.hasresearched.md index 362af2bd7..7b775c76e 100644 --- a/markdown/bitburner.officeapi.hasresearched.md +++ b/markdown/bitburner.officeapi.hasresearched.md @@ -6,7 +6,7 @@ Gets if you have unlocked a research -Signature: +**Signature:** ```typescript hasResearched(divisionName: string, researchName: string): boolean; @@ -19,7 +19,7 @@ hasResearched(divisionName: string, researchName: string): boolean; | divisionName | string | Name of the division | | researchName | string | Name of the research | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.officeapi.hireadvert.md b/markdown/bitburner.officeapi.hireadvert.md index 87a6cd787..225112cfd 100644 --- a/markdown/bitburner.officeapi.hireadvert.md +++ b/markdown/bitburner.officeapi.hireadvert.md @@ -6,7 +6,7 @@ Hire AdVert. -Signature: +**Signature:** ```typescript hireAdVert(divisionName: string): void; @@ -18,7 +18,7 @@ hireAdVert(divisionName: string): void; | --- | --- | --- | | divisionName | string | Name of the division | -Returns: +**Returns:** void diff --git a/markdown/bitburner.officeapi.hireemployee.md b/markdown/bitburner.officeapi.hireemployee.md index e2ab99ad0..3b617dd73 100644 --- a/markdown/bitburner.officeapi.hireemployee.md +++ b/markdown/bitburner.officeapi.hireemployee.md @@ -6,7 +6,7 @@ Hire an employee. -Signature: +**Signature:** ```typescript hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean; @@ -18,9 +18,9 @@ hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosit | --- | --- | --- | | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -| employeePosition | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | Position to place into. Defaults to "Unassigned". | +| employeePosition | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | _(Optional)_ Position to place into. Defaults to "Unassigned". | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.officeapi.md b/markdown/bitburner.officeapi.md index a08b02ab4..fdbfb2f4a 100644 --- a/markdown/bitburner.officeapi.md +++ b/markdown/bitburner.officeapi.md @@ -6,7 +6,7 @@ Corporation Office API -Signature: +**Signature:** ```typescript export interface OfficeAPI diff --git a/markdown/bitburner.officeapi.research.md b/markdown/bitburner.officeapi.research.md index 112f48f38..885c0c676 100644 --- a/markdown/bitburner.officeapi.research.md +++ b/markdown/bitburner.officeapi.research.md @@ -6,7 +6,7 @@ Purchase a research -Signature: +**Signature:** ```typescript research(divisionName: string, researchName: string): void; @@ -19,7 +19,7 @@ research(divisionName: string, researchName: string): void; | divisionName | string | Name of the division | | researchName | string | Name of the research | -Returns: +**Returns:** void diff --git a/markdown/bitburner.officeapi.setautojobassignment.md b/markdown/bitburner.officeapi.setautojobassignment.md index db5113da4..942672cc0 100644 --- a/markdown/bitburner.officeapi.setautojobassignment.md +++ b/markdown/bitburner.officeapi.setautojobassignment.md @@ -6,7 +6,7 @@ Set the auto job assignment for a job -Signature: +**Signature:** ```typescript setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean; @@ -21,7 +21,7 @@ setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: | job | string | Name of the job | | amount | number | Number of employees to assign to that job | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.officeapi.throwparty.md b/markdown/bitburner.officeapi.throwparty.md index 9c4b7cd40..2e8366549 100644 --- a/markdown/bitburner.officeapi.throwparty.md +++ b/markdown/bitburner.officeapi.throwparty.md @@ -6,7 +6,7 @@ Throw a party for your employees -Signature: +**Signature:** ```typescript throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number; @@ -20,7 +20,7 @@ throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | costPerEmployee | number | Amount to spend per employee. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.officeapi.upgradeofficesize.md b/markdown/bitburner.officeapi.upgradeofficesize.md index e99a3f638..e17159c45 100644 --- a/markdown/bitburner.officeapi.upgradeofficesize.md +++ b/markdown/bitburner.officeapi.upgradeofficesize.md @@ -6,7 +6,7 @@ Upgrade office size. -Signature: +**Signature:** ```typescript upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void; @@ -20,7 +20,7 @@ upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: nu | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | size | number | Amount of positions to open | -Returns: +**Returns:** void diff --git a/markdown/bitburner.ordertypes.md b/markdown/bitburner.ordertypes.md index f17bfba71..dadfcc3e2 100644 --- a/markdown/bitburner.ordertypes.md +++ b/markdown/bitburner.ordertypes.md @@ -5,7 +5,7 @@ ## OrderTypes enum -Signature: +**Signature:** ```typescript declare enum OrderTypes diff --git a/markdown/bitburner.person.city.md b/markdown/bitburner.person.city.md index 3f83b97b1..27591c6c1 100644 --- a/markdown/bitburner.person.city.md +++ b/markdown/bitburner.person.city.md @@ -4,7 +4,7 @@ ## Person.city property -Signature: +**Signature:** ```typescript city: CityName; diff --git a/markdown/bitburner.person.exp.md b/markdown/bitburner.person.exp.md index e1a40b733..ce5fb7627 100644 --- a/markdown/bitburner.person.exp.md +++ b/markdown/bitburner.person.exp.md @@ -4,7 +4,7 @@ ## Person.exp property -Signature: +**Signature:** ```typescript exp: Skills; diff --git a/markdown/bitburner.person.hp.md b/markdown/bitburner.person.hp.md index 0acf6dce4..ca3b87b5a 100644 --- a/markdown/bitburner.person.hp.md +++ b/markdown/bitburner.person.hp.md @@ -4,7 +4,7 @@ ## Person.hp property -Signature: +**Signature:** ```typescript hp: HP; diff --git a/markdown/bitburner.person.md b/markdown/bitburner.person.md index c9f44349a..571bc20ce 100644 --- a/markdown/bitburner.person.md +++ b/markdown/bitburner.person.md @@ -5,7 +5,7 @@ ## Person interface -Signature: +**Signature:** ```typescript interface Person @@ -13,11 +13,11 @@ interface Person ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [city](./bitburner.person.city.md) | [CityName](./bitburner.cityname.md) | | -| [exp](./bitburner.person.exp.md) | [Skills](./bitburner.skills.md) | | -| [hp](./bitburner.person.hp.md) | [HP](./bitburner.hp.md) | | -| [mults](./bitburner.person.mults.md) | [Multipliers](./bitburner.multipliers.md) | | -| [skills](./bitburner.person.skills.md) | [Skills](./bitburner.skills.md) | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [city](./bitburner.person.city.md) | | [CityName](./bitburner.cityname.md) | | +| [exp](./bitburner.person.exp.md) | | [Skills](./bitburner.skills.md) | | +| [hp](./bitburner.person.hp.md) | | [HP](./bitburner.hp.md) | | +| [mults](./bitburner.person.mults.md) | | [Multipliers](./bitburner.multipliers.md) | | +| [skills](./bitburner.person.skills.md) | | [Skills](./bitburner.skills.md) | | diff --git a/markdown/bitburner.person.mults.md b/markdown/bitburner.person.mults.md index 8e058476b..3cd9d3444 100644 --- a/markdown/bitburner.person.mults.md +++ b/markdown/bitburner.person.mults.md @@ -4,7 +4,7 @@ ## Person.mults property -Signature: +**Signature:** ```typescript mults: Multipliers; diff --git a/markdown/bitburner.person.skills.md b/markdown/bitburner.person.skills.md index 3cd6423bc..173640f1a 100644 --- a/markdown/bitburner.person.skills.md +++ b/markdown/bitburner.person.skills.md @@ -4,7 +4,7 @@ ## Person.skills property -Signature: +**Signature:** ```typescript skills: Skills; diff --git a/markdown/bitburner.player.bitnoden.md b/markdown/bitburner.player.bitnoden.md index dc10d8bce..dd1e15262 100644 --- a/markdown/bitburner.player.bitnoden.md +++ b/markdown/bitburner.player.bitnoden.md @@ -4,7 +4,7 @@ ## Player.bitNodeN property -Signature: +**Signature:** ```typescript bitNodeN: number; diff --git a/markdown/bitburner.player.entropy.md b/markdown/bitburner.player.entropy.md index 2209c8c9e..f9fe4679d 100644 --- a/markdown/bitburner.player.entropy.md +++ b/markdown/bitburner.player.entropy.md @@ -4,7 +4,7 @@ ## Player.entropy property -Signature: +**Signature:** ```typescript entropy: number; diff --git a/markdown/bitburner.player.factions.md b/markdown/bitburner.player.factions.md index 929d0df30..9fa0e33bc 100644 --- a/markdown/bitburner.player.factions.md +++ b/markdown/bitburner.player.factions.md @@ -4,7 +4,7 @@ ## Player.factions property -Signature: +**Signature:** ```typescript factions: string[]; diff --git a/markdown/bitburner.player.jobs.md b/markdown/bitburner.player.jobs.md index 708eee8b8..7d5ac16a2 100644 --- a/markdown/bitburner.player.jobs.md +++ b/markdown/bitburner.player.jobs.md @@ -4,7 +4,7 @@ ## Player.jobs property -Signature: +**Signature:** ```typescript jobs: Record; diff --git a/markdown/bitburner.player.location.md b/markdown/bitburner.player.location.md index 306830baf..abd704680 100644 --- a/markdown/bitburner.player.location.md +++ b/markdown/bitburner.player.location.md @@ -4,7 +4,7 @@ ## Player.location property -Signature: +**Signature:** ```typescript location: string; diff --git a/markdown/bitburner.player.md b/markdown/bitburner.player.md index 547ce99a1..7e11ff83d 100644 --- a/markdown/bitburner.player.md +++ b/markdown/bitburner.player.md @@ -5,25 +5,25 @@ ## Player interface -Signature: +**Signature:** ```typescript interface Player extends Person ``` -Extends: [Person](./bitburner.person.md) +**Extends:** [Person](./bitburner.person.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [bitNodeN](./bitburner.player.bitnoden.md) | number | | -| [entropy](./bitburner.player.entropy.md) | number | | -| [factions](./bitburner.player.factions.md) | string\[\] | | -| [jobs](./bitburner.player.jobs.md) | Record<string, string> | | -| [location](./bitburner.player.location.md) | string | | -| [money](./bitburner.player.money.md) | number | | -| [numPeopleKilled](./bitburner.player.numpeoplekilled.md) | number | | -| [playtimeSinceLastAug](./bitburner.player.playtimesincelastaug.md) | number | | -| [playtimeSinceLastBitnode](./bitburner.player.playtimesincelastbitnode.md) | number | | -| [totalPlaytime](./bitburner.player.totalplaytime.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [bitNodeN](./bitburner.player.bitnoden.md) | | number | | +| [entropy](./bitburner.player.entropy.md) | | number | | +| [factions](./bitburner.player.factions.md) | | string\[\] | | +| [jobs](./bitburner.player.jobs.md) | | Record<string, string> | | +| [location](./bitburner.player.location.md) | | string | | +| [money](./bitburner.player.money.md) | | number | | +| [numPeopleKilled](./bitburner.player.numpeoplekilled.md) | | number | | +| [playtimeSinceLastAug](./bitburner.player.playtimesincelastaug.md) | | number | | +| [playtimeSinceLastBitnode](./bitburner.player.playtimesincelastbitnode.md) | | number | | +| [totalPlaytime](./bitburner.player.totalplaytime.md) | | number | | diff --git a/markdown/bitburner.player.money.md b/markdown/bitburner.player.money.md index 8aafa95d0..6d4657a1e 100644 --- a/markdown/bitburner.player.money.md +++ b/markdown/bitburner.player.money.md @@ -4,7 +4,7 @@ ## Player.money property -Signature: +**Signature:** ```typescript money: number; diff --git a/markdown/bitburner.player.numpeoplekilled.md b/markdown/bitburner.player.numpeoplekilled.md index 10c50bc2f..3c7646213 100644 --- a/markdown/bitburner.player.numpeoplekilled.md +++ b/markdown/bitburner.player.numpeoplekilled.md @@ -4,7 +4,7 @@ ## Player.numPeopleKilled property -Signature: +**Signature:** ```typescript numPeopleKilled: number; diff --git a/markdown/bitburner.player.playtimesincelastaug.md b/markdown/bitburner.player.playtimesincelastaug.md index a35e3d02d..30aa57c14 100644 --- a/markdown/bitburner.player.playtimesincelastaug.md +++ b/markdown/bitburner.player.playtimesincelastaug.md @@ -4,7 +4,7 @@ ## Player.playtimeSinceLastAug property -Signature: +**Signature:** ```typescript playtimeSinceLastAug: number; diff --git a/markdown/bitburner.player.playtimesincelastbitnode.md b/markdown/bitburner.player.playtimesincelastbitnode.md index 7023b6780..da28bf946 100644 --- a/markdown/bitburner.player.playtimesincelastbitnode.md +++ b/markdown/bitburner.player.playtimesincelastbitnode.md @@ -4,7 +4,7 @@ ## Player.playtimeSinceLastBitnode property -Signature: +**Signature:** ```typescript playtimeSinceLastBitnode: number; diff --git a/markdown/bitburner.player.totalplaytime.md b/markdown/bitburner.player.totalplaytime.md index 0a0469be7..3546db054 100644 --- a/markdown/bitburner.player.totalplaytime.md +++ b/markdown/bitburner.player.totalplaytime.md @@ -4,7 +4,7 @@ ## Player.totalPlaytime property -Signature: +**Signature:** ```typescript totalPlaytime: number; diff --git a/markdown/bitburner.portdata.md b/markdown/bitburner.portdata.md index c5b77a426..9c0226984 100644 --- a/markdown/bitburner.portdata.md +++ b/markdown/bitburner.portdata.md @@ -5,7 +5,7 @@ ## PortData type -Signature: +**Signature:** ```typescript type PortData = string | number; diff --git a/markdown/bitburner.positiontypes.md b/markdown/bitburner.positiontypes.md index e8c376699..1ab4b2e96 100644 --- a/markdown/bitburner.positiontypes.md +++ b/markdown/bitburner.positiontypes.md @@ -5,7 +5,7 @@ ## PositionTypes enum -Signature: +**Signature:** ```typescript declare enum PositionTypes diff --git a/markdown/bitburner.processinfo.args.md b/markdown/bitburner.processinfo.args.md index 868fad1cd..d23799ff3 100644 --- a/markdown/bitburner.processinfo.args.md +++ b/markdown/bitburner.processinfo.args.md @@ -6,7 +6,7 @@ Script's arguments -Signature: +**Signature:** ```typescript args: (string | number | boolean)[]; diff --git a/markdown/bitburner.processinfo.filename.md b/markdown/bitburner.processinfo.filename.md index 1a969a65b..3735b0d25 100644 --- a/markdown/bitburner.processinfo.filename.md +++ b/markdown/bitburner.processinfo.filename.md @@ -6,7 +6,7 @@ Script name. -Signature: +**Signature:** ```typescript filename: string; diff --git a/markdown/bitburner.processinfo.md b/markdown/bitburner.processinfo.md index 840e08283..cd4460b1c 100644 --- a/markdown/bitburner.processinfo.md +++ b/markdown/bitburner.processinfo.md @@ -6,7 +6,7 @@ A single process on a server. -Signature: +**Signature:** ```typescript interface ProcessInfo @@ -14,10 +14,10 @@ interface ProcessInfo ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [args](./bitburner.processinfo.args.md) | (string \| number \| boolean)\[\] | Script's arguments | -| [filename](./bitburner.processinfo.filename.md) | string | Script name. | -| [pid](./bitburner.processinfo.pid.md) | number | Process ID | -| [threads](./bitburner.processinfo.threads.md) | number | Number of threads script is running with | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [args](./bitburner.processinfo.args.md) | | (string \| number \| boolean)\[\] | Script's arguments | +| [filename](./bitburner.processinfo.filename.md) | | string | Script name. | +| [pid](./bitburner.processinfo.pid.md) | | number | Process ID | +| [threads](./bitburner.processinfo.threads.md) | | number | Number of threads script is running with | diff --git a/markdown/bitburner.processinfo.pid.md b/markdown/bitburner.processinfo.pid.md index 395a72be3..eb284aeea 100644 --- a/markdown/bitburner.processinfo.pid.md +++ b/markdown/bitburner.processinfo.pid.md @@ -6,7 +6,7 @@ Process ID -Signature: +**Signature:** ```typescript pid: number; diff --git a/markdown/bitburner.processinfo.threads.md b/markdown/bitburner.processinfo.threads.md index 8ba00b6ce..b50505b2e 100644 --- a/markdown/bitburner.processinfo.threads.md +++ b/markdown/bitburner.processinfo.threads.md @@ -6,7 +6,7 @@ Number of threads script is running with -Signature: +**Signature:** ```typescript threads: number; diff --git a/markdown/bitburner.product.citydata.md b/markdown/bitburner.product.citydata.md index fac1296f2..9816006fd 100644 --- a/markdown/bitburner.product.citydata.md +++ b/markdown/bitburner.product.citydata.md @@ -6,7 +6,7 @@ Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] -Signature: +**Signature:** ```typescript cityData: Record; diff --git a/markdown/bitburner.product.cmp.md b/markdown/bitburner.product.cmp.md index 88e186780..12cad48b0 100644 --- a/markdown/bitburner.product.cmp.md +++ b/markdown/bitburner.product.cmp.md @@ -6,7 +6,7 @@ Competition for the product, only present if "Market Research - Competition" unlocked -Signature: +**Signature:** ```typescript cmp: number | undefined; diff --git a/markdown/bitburner.product.developmentprogress.md b/markdown/bitburner.product.developmentprogress.md index 0949fb793..77394b9ae 100644 --- a/markdown/bitburner.product.developmentprogress.md +++ b/markdown/bitburner.product.developmentprogress.md @@ -6,7 +6,7 @@ Creation progress - A number between 0-100 representing percentage -Signature: +**Signature:** ```typescript developmentProgress: number; diff --git a/markdown/bitburner.product.dmd.md b/markdown/bitburner.product.dmd.md index f771d6e4b..435553d48 100644 --- a/markdown/bitburner.product.dmd.md +++ b/markdown/bitburner.product.dmd.md @@ -6,7 +6,7 @@ Demand for the product, only present if "Market Research - Demand" unlocked -Signature: +**Signature:** ```typescript dmd: number | undefined; diff --git a/markdown/bitburner.product.md b/markdown/bitburner.product.md index c694eb033..29403c422 100644 --- a/markdown/bitburner.product.md +++ b/markdown/bitburner.product.md @@ -6,7 +6,7 @@ Product in a warehouse -Signature: +**Signature:** ```typescript interface Product @@ -14,15 +14,15 @@ interface Product ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cityData](./bitburner.product.citydata.md) | Record<[CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\`, number\[\]> | Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] | -| [cmp](./bitburner.product.cmp.md) | number \| undefined | Competition for the product, only present if "Market Research - Competition" unlocked | -| [developmentProgress](./bitburner.product.developmentprogress.md) | number | Creation progress - A number between 0-100 representing percentage | -| [dmd](./bitburner.product.dmd.md) | number \| undefined | Demand for the product, only present if "Market Research - Demand" unlocked | -| [name](./bitburner.product.name.md) | string | Name of the product | -| [pCost](./bitburner.product.pcost.md) | number | Production cost | -| [properties](./bitburner.product.properties.md) | { \[key: string\]: number } | Product Properties. The data is {qlt, per, dur, rel, aes, fea} | -| [rat](./bitburner.product.rat.md) | number | Product Rating | -| [sCost](./bitburner.product.scost.md) | string \| number | Sell cost, can be "MP+5" | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cityData](./bitburner.product.citydata.md) | | Record<[CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\`, number\[\]> | Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] | +| [cmp](./bitburner.product.cmp.md) | | number \| undefined | Competition for the product, only present if "Market Research - Competition" unlocked | +| [developmentProgress](./bitburner.product.developmentprogress.md) | | number | Creation progress - A number between 0-100 representing percentage | +| [dmd](./bitburner.product.dmd.md) | | number \| undefined | Demand for the product, only present if "Market Research - Demand" unlocked | +| [name](./bitburner.product.name.md) | | string | Name of the product | +| [pCost](./bitburner.product.pcost.md) | | number | Production cost | +| [properties](./bitburner.product.properties.md) | | { \[key: string\]: number } | Product Properties. The data is {qlt, per, dur, rel, aes, fea} | +| [rat](./bitburner.product.rat.md) | | number | Product Rating | +| [sCost](./bitburner.product.scost.md) | | string \| number | Sell cost, can be "MP+5" | diff --git a/markdown/bitburner.product.name.md b/markdown/bitburner.product.name.md index 1652c1672..f73567444 100644 --- a/markdown/bitburner.product.name.md +++ b/markdown/bitburner.product.name.md @@ -6,7 +6,7 @@ Name of the product -Signature: +**Signature:** ```typescript name: string; diff --git a/markdown/bitburner.product.pcost.md b/markdown/bitburner.product.pcost.md index b1b130910..ba9d50aa2 100644 --- a/markdown/bitburner.product.pcost.md +++ b/markdown/bitburner.product.pcost.md @@ -6,7 +6,7 @@ Production cost -Signature: +**Signature:** ```typescript pCost: number; diff --git a/markdown/bitburner.product.properties.md b/markdown/bitburner.product.properties.md index bd202079d..33a0853ab 100644 --- a/markdown/bitburner.product.properties.md +++ b/markdown/bitburner.product.properties.md @@ -6,7 +6,7 @@ Product Properties. The data is {qlt, per, dur, rel, aes, fea} -Signature: +**Signature:** ```typescript properties: { [key: string]: number }; diff --git a/markdown/bitburner.product.rat.md b/markdown/bitburner.product.rat.md index d65342786..20dd8d38f 100644 --- a/markdown/bitburner.product.rat.md +++ b/markdown/bitburner.product.rat.md @@ -6,7 +6,7 @@ Product Rating -Signature: +**Signature:** ```typescript rat: number; diff --git a/markdown/bitburner.product.scost.md b/markdown/bitburner.product.scost.md index b226e879e..97825a85f 100644 --- a/markdown/bitburner.product.scost.md +++ b/markdown/bitburner.product.scost.md @@ -6,7 +6,7 @@ Sell cost, can be "MP+5" -Signature: +**Signature:** ```typescript sCost: string | number; diff --git a/markdown/bitburner.recentscript.md b/markdown/bitburner.recentscript.md index 804d09bc4..e1c57a34e 100644 --- a/markdown/bitburner.recentscript.md +++ b/markdown/bitburner.recentscript.md @@ -5,16 +5,16 @@ ## RecentScript interface -Signature: +**Signature:** ```typescript interface RecentScript extends RunningScript ``` -Extends: [RunningScript](./bitburner.runningscript.md) +**Extends:** [RunningScript](./bitburner.runningscript.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [timeOfDeath](./bitburner.recentscript.timeofdeath.md) | Date | Timestamp of when the script was killed | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [timeOfDeath](./bitburner.recentscript.timeofdeath.md) | | Date | Timestamp of when the script was killed | diff --git a/markdown/bitburner.recentscript.timeofdeath.md b/markdown/bitburner.recentscript.timeofdeath.md index 306281be1..fa0a79ff1 100644 --- a/markdown/bitburner.recentscript.timeofdeath.md +++ b/markdown/bitburner.recentscript.timeofdeath.md @@ -6,7 +6,7 @@ Timestamp of when the script was killed -Signature: +**Signature:** ```typescript timeOfDeath: Date; diff --git a/markdown/bitburner.reputationformulas.calculatefavortorep.md b/markdown/bitburner.reputationformulas.calculatefavortorep.md index eeb6f6a5b..5fab32e5b 100644 --- a/markdown/bitburner.reputationformulas.calculatefavortorep.md +++ b/markdown/bitburner.reputationformulas.calculatefavortorep.md @@ -6,7 +6,7 @@ Calculate the total required amount of faction reputation to reach a target favor. -Signature: +**Signature:** ```typescript calculateFavorToRep(favor: number): number; @@ -18,7 +18,7 @@ calculateFavorToRep(favor: number): number; | --- | --- | --- | | favor | number | target faction favor. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.reputationformulas.calculatereptofavor.md b/markdown/bitburner.reputationformulas.calculatereptofavor.md index 98790966c..053c2beb7 100644 --- a/markdown/bitburner.reputationformulas.calculatereptofavor.md +++ b/markdown/bitburner.reputationformulas.calculatereptofavor.md @@ -6,7 +6,7 @@ Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) -Signature: +**Signature:** ```typescript calculateRepToFavor(rep: number): number; @@ -18,7 +18,7 @@ calculateRepToFavor(rep: number): number; | --- | --- | --- | | rep | number | amount of reputation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.reputationformulas.md b/markdown/bitburner.reputationformulas.md index 65e3bc7ea..398e67e50 100644 --- a/markdown/bitburner.reputationformulas.md +++ b/markdown/bitburner.reputationformulas.md @@ -6,7 +6,7 @@ Reputation formulas -Signature: +**Signature:** ```typescript interface ReputationFormulas diff --git a/markdown/bitburner.reputationformulas.repfromdonation.md b/markdown/bitburner.reputationformulas.repfromdonation.md index 114a2663c..1fe5b1245 100644 --- a/markdown/bitburner.reputationformulas.repfromdonation.md +++ b/markdown/bitburner.reputationformulas.repfromdonation.md @@ -6,7 +6,7 @@ Calculate how much rep would be gained. -Signature: +**Signature:** ```typescript repFromDonation(amount: number, player: Person): number; @@ -19,7 +19,7 @@ repFromDonation(amount: number, player: Person): number; | amount | number | Amount of money donated | | player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | -Returns: +**Returns:** number diff --git a/markdown/bitburner.runningscript.args.md b/markdown/bitburner.runningscript.args.md index c615d1534..a0d42d023 100644 --- a/markdown/bitburner.runningscript.args.md +++ b/markdown/bitburner.runningscript.args.md @@ -6,7 +6,7 @@ Arguments the script was called with -Signature: +**Signature:** ```typescript args: (string | number | boolean)[]; diff --git a/markdown/bitburner.runningscript.filename.md b/markdown/bitburner.runningscript.filename.md index 9df32ed16..9fec679a3 100644 --- a/markdown/bitburner.runningscript.filename.md +++ b/markdown/bitburner.runningscript.filename.md @@ -6,7 +6,7 @@ Filename of the script -Signature: +**Signature:** ```typescript filename: string; diff --git a/markdown/bitburner.runningscript.logs.md b/markdown/bitburner.runningscript.logs.md index 503a0861e..77de9f10b 100644 --- a/markdown/bitburner.runningscript.logs.md +++ b/markdown/bitburner.runningscript.logs.md @@ -6,7 +6,7 @@ Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside `[brackets]` at the start of each line. -Signature: +**Signature:** ```typescript logs: string[]; diff --git a/markdown/bitburner.runningscript.md b/markdown/bitburner.runningscript.md index 21d7ce519..5f4d27dd9 100644 --- a/markdown/bitburner.runningscript.md +++ b/markdown/bitburner.runningscript.md @@ -5,7 +5,7 @@ ## RunningScript interface -Signature: +**Signature:** ```typescript interface RunningScript @@ -13,19 +13,19 @@ interface RunningScript ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [args](./bitburner.runningscript.args.md) | (string \| number \| boolean)\[\] | Arguments the script was called with | -| [filename](./bitburner.runningscript.filename.md) | string | Filename of the script | -| [logs](./bitburner.runningscript.logs.md) | string\[\] | Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside [brackets] at the start of each line. | -| [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) | number | Total amount of hacking experience earned from this script when offline | -| [offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) | number | Total amount of money made by this script when offline | -| [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) | number | Number of seconds that the script has been running offline | -| [onlineExpGained](./bitburner.runningscript.onlineexpgained.md) | number | Total amount of hacking experience earned from this script when online | -| [onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) | number | Total amount of money made by this script when online | -| [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) | number | Number of seconds that this script has been running online | -| [pid](./bitburner.runningscript.pid.md) | number | Process ID. Must be an integer | -| [ramUsage](./bitburner.runningscript.ramusage.md) | number | How much RAM this script uses for ONE thread | -| [server](./bitburner.runningscript.server.md) | string | Hostname of the server on which this script runs | -| [threads](./bitburner.runningscript.threads.md) | number | Number of threads that this script runs with | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [args](./bitburner.runningscript.args.md) | | (string \| number \| boolean)\[\] | Arguments the script was called with | +| [filename](./bitburner.runningscript.filename.md) | | string | Filename of the script | +| [logs](./bitburner.runningscript.logs.md) | | string\[\] | Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside [brackets] at the start of each line. | +| [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) | | number | Total amount of hacking experience earned from this script when offline | +| [offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) | | number | Total amount of money made by this script when offline | +| [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) | | number | Number of seconds that the script has been running offline | +| [onlineExpGained](./bitburner.runningscript.onlineexpgained.md) | | number | Total amount of hacking experience earned from this script when online | +| [onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) | | number | Total amount of money made by this script when online | +| [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) | | number | Number of seconds that this script has been running online | +| [pid](./bitburner.runningscript.pid.md) | | number | Process ID. Must be an integer | +| [ramUsage](./bitburner.runningscript.ramusage.md) | | number | How much RAM this script uses for ONE thread | +| [server](./bitburner.runningscript.server.md) | | string | Hostname of the server on which this script runs | +| [threads](./bitburner.runningscript.threads.md) | | number | Number of threads that this script runs with | diff --git a/markdown/bitburner.runningscript.offlineexpgained.md b/markdown/bitburner.runningscript.offlineexpgained.md index 34b8aa729..fbb9bf796 100644 --- a/markdown/bitburner.runningscript.offlineexpgained.md +++ b/markdown/bitburner.runningscript.offlineexpgained.md @@ -6,7 +6,7 @@ Total amount of hacking experience earned from this script when offline -Signature: +**Signature:** ```typescript offlineExpGained: number; diff --git a/markdown/bitburner.runningscript.offlinemoneymade.md b/markdown/bitburner.runningscript.offlinemoneymade.md index e55bccd89..42ed7c795 100644 --- a/markdown/bitburner.runningscript.offlinemoneymade.md +++ b/markdown/bitburner.runningscript.offlinemoneymade.md @@ -6,7 +6,7 @@ Total amount of money made by this script when offline -Signature: +**Signature:** ```typescript offlineMoneyMade: number; diff --git a/markdown/bitburner.runningscript.offlinerunningtime.md b/markdown/bitburner.runningscript.offlinerunningtime.md index ebe6b1467..a815e02dc 100644 --- a/markdown/bitburner.runningscript.offlinerunningtime.md +++ b/markdown/bitburner.runningscript.offlinerunningtime.md @@ -6,7 +6,7 @@ Number of seconds that the script has been running offline -Signature: +**Signature:** ```typescript offlineRunningTime: number; diff --git a/markdown/bitburner.runningscript.onlineexpgained.md b/markdown/bitburner.runningscript.onlineexpgained.md index dafe1fcdf..d5119bd79 100644 --- a/markdown/bitburner.runningscript.onlineexpgained.md +++ b/markdown/bitburner.runningscript.onlineexpgained.md @@ -6,7 +6,7 @@ Total amount of hacking experience earned from this script when online -Signature: +**Signature:** ```typescript onlineExpGained: number; diff --git a/markdown/bitburner.runningscript.onlinemoneymade.md b/markdown/bitburner.runningscript.onlinemoneymade.md index d206f7b33..7afd59127 100644 --- a/markdown/bitburner.runningscript.onlinemoneymade.md +++ b/markdown/bitburner.runningscript.onlinemoneymade.md @@ -6,7 +6,7 @@ Total amount of money made by this script when online -Signature: +**Signature:** ```typescript onlineMoneyMade: number; diff --git a/markdown/bitburner.runningscript.onlinerunningtime.md b/markdown/bitburner.runningscript.onlinerunningtime.md index 280d2ab44..978f45eca 100644 --- a/markdown/bitburner.runningscript.onlinerunningtime.md +++ b/markdown/bitburner.runningscript.onlinerunningtime.md @@ -6,7 +6,7 @@ Number of seconds that this script has been running online -Signature: +**Signature:** ```typescript onlineRunningTime: number; diff --git a/markdown/bitburner.runningscript.pid.md b/markdown/bitburner.runningscript.pid.md index 0399d5593..b104637cc 100644 --- a/markdown/bitburner.runningscript.pid.md +++ b/markdown/bitburner.runningscript.pid.md @@ -6,7 +6,7 @@ Process ID. Must be an integer -Signature: +**Signature:** ```typescript pid: number; diff --git a/markdown/bitburner.runningscript.ramusage.md b/markdown/bitburner.runningscript.ramusage.md index ce45ffc33..2ddbb3a14 100644 --- a/markdown/bitburner.runningscript.ramusage.md +++ b/markdown/bitburner.runningscript.ramusage.md @@ -6,7 +6,7 @@ How much RAM this script uses for ONE thread -Signature: +**Signature:** ```typescript ramUsage: number; diff --git a/markdown/bitburner.runningscript.server.md b/markdown/bitburner.runningscript.server.md index 246ca1a75..814c4160d 100644 --- a/markdown/bitburner.runningscript.server.md +++ b/markdown/bitburner.runningscript.server.md @@ -6,7 +6,7 @@ Hostname of the server on which this script runs -Signature: +**Signature:** ```typescript server: string; diff --git a/markdown/bitburner.runningscript.threads.md b/markdown/bitburner.runningscript.threads.md index 83ec797c5..d4cdd7177 100644 --- a/markdown/bitburner.runningscript.threads.md +++ b/markdown/bitburner.runningscript.threads.md @@ -6,7 +6,7 @@ Number of threads that this script runs with -Signature: +**Signature:** ```typescript threads: number; diff --git a/markdown/bitburner.scriptarg.md b/markdown/bitburner.scriptarg.md index d898c4053..3288922aa 100644 --- a/markdown/bitburner.scriptarg.md +++ b/markdown/bitburner.scriptarg.md @@ -5,7 +5,7 @@ ## ScriptArg type -Signature: +**Signature:** ```typescript type ScriptArg = string | number | boolean; diff --git a/markdown/bitburner.server.backdoorinstalled.md b/markdown/bitburner.server.backdoorinstalled.md index dc8b9f19e..01374d889 100644 --- a/markdown/bitburner.server.backdoorinstalled.md +++ b/markdown/bitburner.server.backdoorinstalled.md @@ -6,7 +6,7 @@ Flag indicating whether this server has a backdoor installed by a player -Signature: +**Signature:** ```typescript backdoorInstalled: boolean; diff --git a/markdown/bitburner.server.basedifficulty.md b/markdown/bitburner.server.basedifficulty.md index 56a418311..c19160de1 100644 --- a/markdown/bitburner.server.basedifficulty.md +++ b/markdown/bitburner.server.basedifficulty.md @@ -6,7 +6,7 @@ Initial server security level (i.e. security level when the server was created) -Signature: +**Signature:** ```typescript baseDifficulty: number; diff --git a/markdown/bitburner.server.cpucores.md b/markdown/bitburner.server.cpucores.md index 0bf4287dc..e70b3970a 100644 --- a/markdown/bitburner.server.cpucores.md +++ b/markdown/bitburner.server.cpucores.md @@ -6,7 +6,7 @@ How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. -Signature: +**Signature:** ```typescript cpuCores: number; diff --git a/markdown/bitburner.server.ftpportopen.md b/markdown/bitburner.server.ftpportopen.md index 6d1fd9490..156e38ad8 100644 --- a/markdown/bitburner.server.ftpportopen.md +++ b/markdown/bitburner.server.ftpportopen.md @@ -6,7 +6,7 @@ Flag indicating whether the FTP port is open -Signature: +**Signature:** ```typescript ftpPortOpen: boolean; diff --git a/markdown/bitburner.server.hackdifficulty.md b/markdown/bitburner.server.hackdifficulty.md index e9c8b4b68..4d17c60c9 100644 --- a/markdown/bitburner.server.hackdifficulty.md +++ b/markdown/bitburner.server.hackdifficulty.md @@ -6,7 +6,7 @@ Server Security Level -Signature: +**Signature:** ```typescript hackDifficulty: number; diff --git a/markdown/bitburner.server.hasadminrights.md b/markdown/bitburner.server.hasadminrights.md index 4dc4892d7..3cc6c80fb 100644 --- a/markdown/bitburner.server.hasadminrights.md +++ b/markdown/bitburner.server.hasadminrights.md @@ -6,7 +6,7 @@ Flag indicating whether player has admin/root access to this server -Signature: +**Signature:** ```typescript hasAdminRights: boolean; diff --git a/markdown/bitburner.server.hostname.md b/markdown/bitburner.server.hostname.md index f0aaea4bd..8e766c7d1 100644 --- a/markdown/bitburner.server.hostname.md +++ b/markdown/bitburner.server.hostname.md @@ -6,7 +6,7 @@ Hostname. Must be unique -Signature: +**Signature:** ```typescript hostname: string; diff --git a/markdown/bitburner.server.httpportopen.md b/markdown/bitburner.server.httpportopen.md index 6c5568a8a..4434a5b4d 100644 --- a/markdown/bitburner.server.httpportopen.md +++ b/markdown/bitburner.server.httpportopen.md @@ -6,7 +6,7 @@ Flag indicating whether HTTP Port is open -Signature: +**Signature:** ```typescript httpPortOpen: boolean; diff --git a/markdown/bitburner.server.ip.md b/markdown/bitburner.server.ip.md index 64e46a81b..485b6326c 100644 --- a/markdown/bitburner.server.ip.md +++ b/markdown/bitburner.server.ip.md @@ -6,7 +6,7 @@ IP Address. Must be unique -Signature: +**Signature:** ```typescript ip: string; diff --git a/markdown/bitburner.server.isconnectedto.md b/markdown/bitburner.server.isconnectedto.md index d32099e16..e7400304e 100644 --- a/markdown/bitburner.server.isconnectedto.md +++ b/markdown/bitburner.server.isconnectedto.md @@ -6,7 +6,7 @@ Flag indicating whether player is currently connected to this server -Signature: +**Signature:** ```typescript isConnectedTo: boolean; diff --git a/markdown/bitburner.server.maxram.md b/markdown/bitburner.server.maxram.md index 75bb5bcb3..740585138 100644 --- a/markdown/bitburner.server.maxram.md +++ b/markdown/bitburner.server.maxram.md @@ -6,7 +6,7 @@ RAM (GB) available on this server -Signature: +**Signature:** ```typescript maxRam: number; diff --git a/markdown/bitburner.server.md b/markdown/bitburner.server.md index e6c092412..d2a488892 100644 --- a/markdown/bitburner.server.md +++ b/markdown/bitburner.server.md @@ -6,7 +6,7 @@ A single server. -Signature: +**Signature:** ```typescript interface Server @@ -14,30 +14,30 @@ interface Server ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [backdoorInstalled](./bitburner.server.backdoorinstalled.md) | boolean | Flag indicating whether this server has a backdoor installed by a player | -| [baseDifficulty](./bitburner.server.basedifficulty.md) | number | Initial server security level (i.e. security level when the server was created) | -| [cpuCores](./bitburner.server.cpucores.md) | number | How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. | -| [ftpPortOpen](./bitburner.server.ftpportopen.md) | boolean | Flag indicating whether the FTP port is open | -| [hackDifficulty](./bitburner.server.hackdifficulty.md) | number | Server Security Level | -| [hasAdminRights](./bitburner.server.hasadminrights.md) | boolean | Flag indicating whether player has admin/root access to this server | -| [hostname](./bitburner.server.hostname.md) | string | Hostname. Must be unique | -| [httpPortOpen](./bitburner.server.httpportopen.md) | boolean | Flag indicating whether HTTP Port is open | -| [ip](./bitburner.server.ip.md) | string | IP Address. Must be unique | -| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | Flag indicating whether player is currently connected to this server | -| [maxRam](./bitburner.server.maxram.md) | number | RAM (GB) available on this server | -| [minDifficulty](./bitburner.server.mindifficulty.md) | number | Minimum server security level that this server can be weakened to | -| [moneyAvailable](./bitburner.server.moneyavailable.md) | number | How much money currently resides on the server and can be hacked | -| [moneyMax](./bitburner.server.moneymax.md) | number | Maximum amount of money that this server can hold | -| [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md) | number | Number of open ports required in order to gain admin/root access | -| [openPortCount](./bitburner.server.openportcount.md) | number | How many ports are currently opened on the server | -| [organizationName](./bitburner.server.organizationname.md) | string | Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers | -| [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) | boolean | Flag indicating whether this is a purchased server | -| [ramUsed](./bitburner.server.ramused.md) | number | RAM (GB) used. i.e. unavailable RAM | -| [requiredHackingSkill](./bitburner.server.requiredhackingskill.md) | number | Hacking level required to hack this server | -| [serverGrowth](./bitburner.server.servergrowth.md) | number | Parameter that affects how effectively this server's money can be increased using the grow() Netscript function | -| [smtpPortOpen](./bitburner.server.smtpportopen.md) | boolean | Flag indicating whether SMTP Port is open | -| [sqlPortOpen](./bitburner.server.sqlportopen.md) | boolean | Flag indicating whether SQL Port is open | -| [sshPortOpen](./bitburner.server.sshportopen.md) | boolean | Flag indicating whether the SSH Port is open | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [backdoorInstalled](./bitburner.server.backdoorinstalled.md) | | boolean | Flag indicating whether this server has a backdoor installed by a player | +| [baseDifficulty](./bitburner.server.basedifficulty.md) | | number | Initial server security level (i.e. security level when the server was created) | +| [cpuCores](./bitburner.server.cpucores.md) | | number | How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. | +| [ftpPortOpen](./bitburner.server.ftpportopen.md) | | boolean | Flag indicating whether the FTP port is open | +| [hackDifficulty](./bitburner.server.hackdifficulty.md) | | number | Server Security Level | +| [hasAdminRights](./bitburner.server.hasadminrights.md) | | boolean | Flag indicating whether player has admin/root access to this server | +| [hostname](./bitburner.server.hostname.md) | | string | Hostname. Must be unique | +| [httpPortOpen](./bitburner.server.httpportopen.md) | | boolean | Flag indicating whether HTTP Port is open | +| [ip](./bitburner.server.ip.md) | | string | IP Address. Must be unique | +| [isConnectedTo](./bitburner.server.isconnectedto.md) | | boolean | Flag indicating whether player is currently connected to this server | +| [maxRam](./bitburner.server.maxram.md) | | number | RAM (GB) available on this server | +| [minDifficulty](./bitburner.server.mindifficulty.md) | | number | Minimum server security level that this server can be weakened to | +| [moneyAvailable](./bitburner.server.moneyavailable.md) | | number | How much money currently resides on the server and can be hacked | +| [moneyMax](./bitburner.server.moneymax.md) | | number | Maximum amount of money that this server can hold | +| [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md) | | number | Number of open ports required in order to gain admin/root access | +| [openPortCount](./bitburner.server.openportcount.md) | | number | How many ports are currently opened on the server | +| [organizationName](./bitburner.server.organizationname.md) | | string | Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers | +| [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) | | boolean | Flag indicating whether this is a purchased server | +| [ramUsed](./bitburner.server.ramused.md) | | number | RAM (GB) used. i.e. unavailable RAM | +| [requiredHackingSkill](./bitburner.server.requiredhackingskill.md) | | number | Hacking level required to hack this server | +| [serverGrowth](./bitburner.server.servergrowth.md) | | number | Parameter that affects how effectively this server's money can be increased using the grow() Netscript function | +| [smtpPortOpen](./bitburner.server.smtpportopen.md) | | boolean | Flag indicating whether SMTP Port is open | +| [sqlPortOpen](./bitburner.server.sqlportopen.md) | | boolean | Flag indicating whether SQL Port is open | +| [sshPortOpen](./bitburner.server.sshportopen.md) | | boolean | Flag indicating whether the SSH Port is open | diff --git a/markdown/bitburner.server.mindifficulty.md b/markdown/bitburner.server.mindifficulty.md index 4f8ad40ae..1bcbf958f 100644 --- a/markdown/bitburner.server.mindifficulty.md +++ b/markdown/bitburner.server.mindifficulty.md @@ -6,7 +6,7 @@ Minimum server security level that this server can be weakened to -Signature: +**Signature:** ```typescript minDifficulty: number; diff --git a/markdown/bitburner.server.moneyavailable.md b/markdown/bitburner.server.moneyavailable.md index f8c3ed2ad..2612fd1c8 100644 --- a/markdown/bitburner.server.moneyavailable.md +++ b/markdown/bitburner.server.moneyavailable.md @@ -6,7 +6,7 @@ How much money currently resides on the server and can be hacked -Signature: +**Signature:** ```typescript moneyAvailable: number; diff --git a/markdown/bitburner.server.moneymax.md b/markdown/bitburner.server.moneymax.md index 40fba72c0..8118387a0 100644 --- a/markdown/bitburner.server.moneymax.md +++ b/markdown/bitburner.server.moneymax.md @@ -6,7 +6,7 @@ Maximum amount of money that this server can hold -Signature: +**Signature:** ```typescript moneyMax: number; diff --git a/markdown/bitburner.server.numopenportsrequired.md b/markdown/bitburner.server.numopenportsrequired.md index eb8d16369..e145d607a 100644 --- a/markdown/bitburner.server.numopenportsrequired.md +++ b/markdown/bitburner.server.numopenportsrequired.md @@ -6,7 +6,7 @@ Number of open ports required in order to gain admin/root access -Signature: +**Signature:** ```typescript numOpenPortsRequired: number; diff --git a/markdown/bitburner.server.openportcount.md b/markdown/bitburner.server.openportcount.md index f57694725..a206af08a 100644 --- a/markdown/bitburner.server.openportcount.md +++ b/markdown/bitburner.server.openportcount.md @@ -6,7 +6,7 @@ How many ports are currently opened on the server -Signature: +**Signature:** ```typescript openPortCount: number; diff --git a/markdown/bitburner.server.organizationname.md b/markdown/bitburner.server.organizationname.md index 5becf3a28..cdaed7c20 100644 --- a/markdown/bitburner.server.organizationname.md +++ b/markdown/bitburner.server.organizationname.md @@ -6,7 +6,7 @@ Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers -Signature: +**Signature:** ```typescript organizationName: string; diff --git a/markdown/bitburner.server.purchasedbyplayer.md b/markdown/bitburner.server.purchasedbyplayer.md index c1bf7862a..ebd49a4df 100644 --- a/markdown/bitburner.server.purchasedbyplayer.md +++ b/markdown/bitburner.server.purchasedbyplayer.md @@ -6,7 +6,7 @@ Flag indicating whether this is a purchased server -Signature: +**Signature:** ```typescript purchasedByPlayer: boolean; diff --git a/markdown/bitburner.server.ramused.md b/markdown/bitburner.server.ramused.md index 59c5d1447..534c88a7d 100644 --- a/markdown/bitburner.server.ramused.md +++ b/markdown/bitburner.server.ramused.md @@ -6,7 +6,7 @@ RAM (GB) used. i.e. unavailable RAM -Signature: +**Signature:** ```typescript ramUsed: number; diff --git a/markdown/bitburner.server.requiredhackingskill.md b/markdown/bitburner.server.requiredhackingskill.md index 0617859a4..cc2081490 100644 --- a/markdown/bitburner.server.requiredhackingskill.md +++ b/markdown/bitburner.server.requiredhackingskill.md @@ -6,7 +6,7 @@ Hacking level required to hack this server -Signature: +**Signature:** ```typescript requiredHackingSkill: number; diff --git a/markdown/bitburner.server.servergrowth.md b/markdown/bitburner.server.servergrowth.md index 549490455..cf6f60045 100644 --- a/markdown/bitburner.server.servergrowth.md +++ b/markdown/bitburner.server.servergrowth.md @@ -6,7 +6,7 @@ Parameter that affects how effectively this server's money can be increased using the grow() Netscript function -Signature: +**Signature:** ```typescript serverGrowth: number; diff --git a/markdown/bitburner.server.smtpportopen.md b/markdown/bitburner.server.smtpportopen.md index e958832fa..c1d4fddda 100644 --- a/markdown/bitburner.server.smtpportopen.md +++ b/markdown/bitburner.server.smtpportopen.md @@ -6,7 +6,7 @@ Flag indicating whether SMTP Port is open -Signature: +**Signature:** ```typescript smtpPortOpen: boolean; diff --git a/markdown/bitburner.server.sqlportopen.md b/markdown/bitburner.server.sqlportopen.md index 1b964977d..d7c74757b 100644 --- a/markdown/bitburner.server.sqlportopen.md +++ b/markdown/bitburner.server.sqlportopen.md @@ -6,7 +6,7 @@ Flag indicating whether SQL Port is open -Signature: +**Signature:** ```typescript sqlPortOpen: boolean; diff --git a/markdown/bitburner.server.sshportopen.md b/markdown/bitburner.server.sshportopen.md index b1f086ab5..3e6b01ab9 100644 --- a/markdown/bitburner.server.sshportopen.md +++ b/markdown/bitburner.server.sshportopen.md @@ -6,7 +6,7 @@ Flag indicating whether the SSH Port is open -Signature: +**Signature:** ```typescript sshPortOpen: boolean; diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md index eeeb6b45a..0c897375a 100644 --- a/markdown/bitburner.singularity.applytocompany.md +++ b/markdown/bitburner.singularity.applytocompany.md @@ -6,7 +6,7 @@ Apply for a job at a company. -Signature: +**Signature:** ```typescript applyToCompany(companyName: string, field: string): boolean; @@ -19,7 +19,7 @@ applyToCompany(companyName: string, field: string): boolean; | companyName | string | Name of company to apply to. | | field | string | Field to which you want to apply. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.b1tflum3.md b/markdown/bitburner.singularity.b1tflum3.md index 0b3c6b451..33c28a898 100644 --- a/markdown/bitburner.singularity.b1tflum3.md +++ b/markdown/bitburner.singularity.b1tflum3.md @@ -6,7 +6,7 @@ b1t\_flum3 into a different BN. -Signature: +**Signature:** ```typescript b1tflum3(nextBN: number, callbackScript?: string): void; @@ -17,9 +17,9 @@ b1tflum3(nextBN: number, callbackScript?: string): void; | Parameter | Type | Description | | --- | --- | --- | | nextBN | number | BN number to jump to | -| callbackScript | string | Name of the script to launch in the next BN. | +| callbackScript | string | _(Optional)_ Name of the script to launch in the next BN. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md index 6c75e54c7..3574f8c28 100644 --- a/markdown/bitburner.singularity.checkfactioninvitations.md +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -6,12 +6,12 @@ List all current faction invitations. -Signature: +**Signature:** ```typescript checkFactionInvitations(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md index 7ff0da6fc..60fc756f8 100644 --- a/markdown/bitburner.singularity.commitcrime.md +++ b/markdown/bitburner.singularity.commitcrime.md @@ -6,7 +6,7 @@ Commit a crime. -Signature: +**Signature:** ```typescript commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number; @@ -17,9 +17,9 @@ commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number; | Parameter | Type | Description | | --- | --- | --- | | crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime to attempt. | -| focus | boolean | Acquire player focus on this crime. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this crime. Optional. Defaults to true. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.connect.md b/markdown/bitburner.singularity.connect.md index 97fe2ffa0..320313e3d 100644 --- a/markdown/bitburner.singularity.connect.md +++ b/markdown/bitburner.singularity.connect.md @@ -6,7 +6,7 @@ Connect to a server. -Signature: +**Signature:** ```typescript connect(hostname: string): boolean; @@ -18,7 +18,7 @@ connect(hostname: string): boolean; | --- | --- | --- | | hostname | string | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md index f856dcc9e..7e09b99c2 100644 --- a/markdown/bitburner.singularity.createprogram.md +++ b/markdown/bitburner.singularity.createprogram.md @@ -6,7 +6,7 @@ Create a program. -Signature: +**Signature:** ```typescript createProgram(program: string, focus?: boolean): boolean; @@ -17,9 +17,9 @@ createProgram(program: string, focus?: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | | program | string | Name of program to create. | -| focus | boolean | Acquire player focus on this program creation. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this program creation. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.destroyw0r1dd43m0n.md b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md index a0987f783..f4ccd8c5f 100644 --- a/markdown/bitburner.singularity.destroyw0r1dd43m0n.md +++ b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md @@ -6,7 +6,7 @@ Destroy the w0r1d\_d43m0n and move on to the next BN. -Signature: +**Signature:** ```typescript destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void; @@ -17,9 +17,9 @@ destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void; | Parameter | Type | Description | | --- | --- | --- | | nextBN | number | BN number to jump to | -| callbackScript | string | Name of the script to launch in the next BN. | +| callbackScript | string | _(Optional)_ Name of the script to launch in the next BN. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md index 1fa0e81b6..feae473d1 100644 --- a/markdown/bitburner.singularity.donatetofaction.md +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -6,7 +6,7 @@ Donate to a faction. -Signature: +**Signature:** ```typescript donateToFaction(faction: string, amount: number): boolean; @@ -19,7 +19,7 @@ donateToFaction(faction: string, amount: number): boolean; | faction | string | Name of faction to donate to. | | amount | number | Amount of money to donate. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.exportgame.md b/markdown/bitburner.singularity.exportgame.md index 3f97fe5cb..2ee0219c1 100644 --- a/markdown/bitburner.singularity.exportgame.md +++ b/markdown/bitburner.singularity.exportgame.md @@ -6,12 +6,12 @@ Backup game save. -Signature: +**Signature:** ```typescript exportGame(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.singularity.exportgamebonus.md b/markdown/bitburner.singularity.exportgamebonus.md index b439ffa0e..caefe7c52 100644 --- a/markdown/bitburner.singularity.exportgamebonus.md +++ b/markdown/bitburner.singularity.exportgamebonus.md @@ -6,12 +6,12 @@ Returns Backup save bonus availability. -Signature: +**Signature:** ```typescript exportGameBonus(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.getaugmentationbaseprice.md b/markdown/bitburner.singularity.getaugmentationbaseprice.md index 7a4fcb5df..61309a968 100644 --- a/markdown/bitburner.singularity.getaugmentationbaseprice.md +++ b/markdown/bitburner.singularity.getaugmentationbaseprice.md @@ -6,7 +6,7 @@ Get base price of an augmentation. -Signature: +**Signature:** ```typescript getAugmentationBasePrice(augName: string): number; @@ -18,7 +18,7 @@ getAugmentationBasePrice(augName: string): number; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md index 5eea5c996..754c21660 100644 --- a/markdown/bitburner.singularity.getaugmentationprereq.md +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -6,7 +6,7 @@ Get the pre-requisite of an augmentation. -Signature: +**Signature:** ```typescript getAugmentationPrereq(augName: string): string[]; @@ -18,7 +18,7 @@ getAugmentationPrereq(augName: string): string[]; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.singularity.getaugmentationprice.md b/markdown/bitburner.singularity.getaugmentationprice.md index d071bd667..a21cd9cf2 100644 --- a/markdown/bitburner.singularity.getaugmentationprice.md +++ b/markdown/bitburner.singularity.getaugmentationprice.md @@ -6,7 +6,7 @@ Get price of an augmentation. -Signature: +**Signature:** ```typescript getAugmentationPrice(augName: string): number; @@ -18,7 +18,7 @@ getAugmentationPrice(augName: string): number; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getaugmentationrepreq.md b/markdown/bitburner.singularity.getaugmentationrepreq.md index 4813a92dc..d1583f4f4 100644 --- a/markdown/bitburner.singularity.getaugmentationrepreq.md +++ b/markdown/bitburner.singularity.getaugmentationrepreq.md @@ -6,7 +6,7 @@ Get reputation requirement of an augmentation. -Signature: +**Signature:** ```typescript getAugmentationRepReq(augName: string): number; @@ -18,7 +18,7 @@ getAugmentationRepReq(augName: string): number; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md index d12b08943..9a2fc2933 100644 --- a/markdown/bitburner.singularity.getaugmentationsfromfaction.md +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -6,7 +6,7 @@ Get a list of augmentation available from a faction. -Signature: +**Signature:** ```typescript getAugmentationsFromFaction(faction: string): string[]; @@ -18,7 +18,7 @@ getAugmentationsFromFaction(faction: string): string[]; | --- | --- | --- | | faction | string | Name of faction. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md index 12056f334..2cd3134e5 100644 --- a/markdown/bitburner.singularity.getaugmentationstats.md +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -6,7 +6,7 @@ Get the stats of an augmentation. -Signature: +**Signature:** ```typescript getAugmentationStats(name: string): Multipliers; @@ -18,7 +18,7 @@ getAugmentationStats(name: string): Multipliers; | --- | --- | --- | | name | string | Name of Augmentation. CASE-SENSITIVE. | -Returns: +**Returns:** [Multipliers](./bitburner.multipliers.md) diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md index 5d43bce39..1ebeece5b 100644 --- a/markdown/bitburner.singularity.getcompanyfavor.md +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -6,7 +6,7 @@ Get company favor. -Signature: +**Signature:** ```typescript getCompanyFavor(companyName: string): number; @@ -18,7 +18,7 @@ getCompanyFavor(companyName: string): number; | --- | --- | --- | | companyName | string | Name of the company. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md index 84582a29a..4beaa7b18 100644 --- a/markdown/bitburner.singularity.getcompanyfavorgain.md +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -6,7 +6,7 @@ Get company favor gain. -Signature: +**Signature:** ```typescript getCompanyFavorGain(companyName: string): number; @@ -18,7 +18,7 @@ getCompanyFavorGain(companyName: string): number; | --- | --- | --- | | companyName | string | Name of the company. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md index d0e0755ce..93957814e 100644 --- a/markdown/bitburner.singularity.getcompanyrep.md +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -6,7 +6,7 @@ Get company reputation. -Signature: +**Signature:** ```typescript getCompanyRep(companyName: string): number; @@ -18,7 +18,7 @@ getCompanyRep(companyName: string): number; | --- | --- | --- | | companyName | string | Name of the company. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index fb50c3b6a..11a0ccaea 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -6,7 +6,7 @@ Get chance to successfully commit a crime. -Signature: +**Signature:** ```typescript getCrimeChance(crime: CrimeType | `${CrimeType}`): number; @@ -18,7 +18,7 @@ getCrimeChance(crime: CrimeType | `${CrimeType}`): number; | --- | --- | --- | | crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md index 287906ca9..f034d673b 100644 --- a/markdown/bitburner.singularity.getcrimestats.md +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -6,7 +6,7 @@ Get stats related to a crime. -Signature: +**Signature:** ```typescript getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats; @@ -18,7 +18,7 @@ getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats; | --- | --- | --- | | crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime. | -Returns: +**Returns:** [CrimeStats](./bitburner.crimestats.md) diff --git a/markdown/bitburner.singularity.getcurrentserver.md b/markdown/bitburner.singularity.getcurrentserver.md index 32aab3285..b9d5b0b9e 100644 --- a/markdown/bitburner.singularity.getcurrentserver.md +++ b/markdown/bitburner.singularity.getcurrentserver.md @@ -6,12 +6,12 @@ Get the current server. -Signature: +**Signature:** ```typescript getCurrentServer(): string; ``` -Returns: +**Returns:** string diff --git a/markdown/bitburner.singularity.getcurrentwork.md b/markdown/bitburner.singularity.getcurrentwork.md index 3bdd61d08..8bf524a46 100644 --- a/markdown/bitburner.singularity.getcurrentwork.md +++ b/markdown/bitburner.singularity.getcurrentwork.md @@ -6,12 +6,12 @@ Get the current work the player is doing. -Signature: +**Signature:** ```typescript getCurrentWork(): any | null; ``` -Returns: +**Returns:** any \| null diff --git a/markdown/bitburner.singularity.getdarkwebprogramcost.md b/markdown/bitburner.singularity.getdarkwebprogramcost.md index fb32cae82..ecc22f2ae 100644 --- a/markdown/bitburner.singularity.getdarkwebprogramcost.md +++ b/markdown/bitburner.singularity.getdarkwebprogramcost.md @@ -6,7 +6,7 @@ Check the price of an exploit on the dark web -Signature: +**Signature:** ```typescript getDarkwebProgramCost(programName: string): number; @@ -18,7 +18,7 @@ getDarkwebProgramCost(programName: string): number; | --- | --- | --- | | programName | string | Name of program to check the price of | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getdarkwebprograms.md b/markdown/bitburner.singularity.getdarkwebprograms.md index 3887dcfd9..4562f1588 100644 --- a/markdown/bitburner.singularity.getdarkwebprograms.md +++ b/markdown/bitburner.singularity.getdarkwebprograms.md @@ -6,12 +6,12 @@ Get a list of programs offered on the dark web. -Signature: +**Signature:** ```typescript getDarkwebPrograms(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md index abdfc46f7..4c46a2a8b 100644 --- a/markdown/bitburner.singularity.getfactionfavor.md +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -6,7 +6,7 @@ Get faction favor. -Signature: +**Signature:** ```typescript getFactionFavor(faction: string): number; @@ -18,7 +18,7 @@ getFactionFavor(faction: string): number; | --- | --- | --- | | faction | string | Name of faction. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getfactionfavorgain.md b/markdown/bitburner.singularity.getfactionfavorgain.md index ca8d8b384..dab454bc4 100644 --- a/markdown/bitburner.singularity.getfactionfavorgain.md +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -6,7 +6,7 @@ Get faction favor gain. -Signature: +**Signature:** ```typescript getFactionFavorGain(faction: string): number; @@ -18,7 +18,7 @@ getFactionFavorGain(faction: string): number; | --- | --- | --- | | faction | string | Name of faction. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md index 5c2f0b661..c645637ea 100644 --- a/markdown/bitburner.singularity.getfactionrep.md +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -6,7 +6,7 @@ Get faction reputation. -Signature: +**Signature:** ```typescript getFactionRep(faction: string): number; @@ -18,7 +18,7 @@ getFactionRep(faction: string): number; | --- | --- | --- | | faction | string | Name of faction to work for. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getownedaugmentations.md b/markdown/bitburner.singularity.getownedaugmentations.md index 34cd7f36f..c5d08c8a3 100644 --- a/markdown/bitburner.singularity.getownedaugmentations.md +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -6,7 +6,7 @@ Get a list of owned augmentation. -Signature: +**Signature:** ```typescript getOwnedAugmentations(purchased?: boolean): string[]; @@ -16,9 +16,9 @@ getOwnedAugmentations(purchased?: boolean): string[]; | 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. | +| purchased | boolean | _(Optional)_ 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: +**Returns:** string\[\] diff --git a/markdown/bitburner.singularity.getownedsourcefiles.md b/markdown/bitburner.singularity.getownedsourcefiles.md index de472bff2..7613cd881 100644 --- a/markdown/bitburner.singularity.getownedsourcefiles.md +++ b/markdown/bitburner.singularity.getownedsourcefiles.md @@ -6,12 +6,12 @@ Get a list of acquired Source-Files. -Signature: +**Signature:** ```typescript getOwnedSourceFiles(): SourceFileLvl[]; ``` -Returns: +**Returns:** [SourceFileLvl](./bitburner.sourcefilelvl.md)\[\] diff --git a/markdown/bitburner.singularity.getupgradehomecorescost.md b/markdown/bitburner.singularity.getupgradehomecorescost.md index 1c1ee5944..fcd724667 100644 --- a/markdown/bitburner.singularity.getupgradehomecorescost.md +++ b/markdown/bitburner.singularity.getupgradehomecorescost.md @@ -6,12 +6,12 @@ Get the price of upgrading home cores. -Signature: +**Signature:** ```typescript getUpgradeHomeCoresCost(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.getupgradehomeramcost.md b/markdown/bitburner.singularity.getupgradehomeramcost.md index 5e250742f..f9ae0b307 100644 --- a/markdown/bitburner.singularity.getupgradehomeramcost.md +++ b/markdown/bitburner.singularity.getupgradehomeramcost.md @@ -6,12 +6,12 @@ Get the price of upgrading home RAM. -Signature: +**Signature:** ```typescript getUpgradeHomeRamCost(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.singularity.gotolocation.md b/markdown/bitburner.singularity.gotolocation.md index 6f40592e4..e756edf39 100644 --- a/markdown/bitburner.singularity.gotolocation.md +++ b/markdown/bitburner.singularity.gotolocation.md @@ -6,7 +6,7 @@ Go to a location. -Signature: +**Signature:** ```typescript goToLocation(locationName: string): boolean; @@ -18,7 +18,7 @@ goToLocation(locationName: string): boolean; | --- | --- | --- | | locationName | string | Name of the location. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md index 7b57d4736..274e3397f 100644 --- a/markdown/bitburner.singularity.gymworkout.md +++ b/markdown/bitburner.singularity.gymworkout.md @@ -6,7 +6,7 @@ Workout at the gym. -Signature: +**Signature:** ```typescript gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; @@ -18,9 +18,9 @@ gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; | --- | --- | --- | | gymName | string | Name of gym. You must be in the correct city for whatever gym you specify. | | stat | string | The stat you want to train. | -| focus | boolean | Acquire player focus on this gym workout. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.hospitalize.md b/markdown/bitburner.singularity.hospitalize.md index 16f491c4b..8d54d6dc2 100644 --- a/markdown/bitburner.singularity.hospitalize.md +++ b/markdown/bitburner.singularity.hospitalize.md @@ -6,12 +6,12 @@ Hospitalize the player. -Signature: +**Signature:** ```typescript hospitalize(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md index d6cc103b9..5a23cbbb7 100644 --- a/markdown/bitburner.singularity.installaugmentations.md +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -6,7 +6,7 @@ Install your purchased augmentations. -Signature: +**Signature:** ```typescript installAugmentations(cbScript?: string): void; @@ -16,9 +16,9 @@ installAugmentations(cbScript?: string): void; | Parameter | Type | Description | | --- | --- | --- | -| cbScript | string | 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. | +| cbScript | string | _(Optional)_ 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: +**Returns:** void diff --git a/markdown/bitburner.singularity.installbackdoor.md b/markdown/bitburner.singularity.installbackdoor.md index 3d85dac5c..7979aa267 100644 --- a/markdown/bitburner.singularity.installbackdoor.md +++ b/markdown/bitburner.singularity.installbackdoor.md @@ -6,12 +6,12 @@ Run the backdoor command in the terminal. -Signature: +**Signature:** ```typescript installBackdoor(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md index 5c0e5725b..120519224 100644 --- a/markdown/bitburner.singularity.isbusy.md +++ b/markdown/bitburner.singularity.isbusy.md @@ -6,12 +6,12 @@ Check if the player is busy. -Signature: +**Signature:** ```typescript isBusy(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.isfocused.md b/markdown/bitburner.singularity.isfocused.md index 4f65c51ce..c27c778bc 100644 --- a/markdown/bitburner.singularity.isfocused.md +++ b/markdown/bitburner.singularity.isfocused.md @@ -6,12 +6,12 @@ Check if the player is focused. -Signature: +**Signature:** ```typescript isFocused(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md index 4fe141f51..d3f4c8eb3 100644 --- a/markdown/bitburner.singularity.joinfaction.md +++ b/markdown/bitburner.singularity.joinfaction.md @@ -6,7 +6,7 @@ Join a faction. -Signature: +**Signature:** ```typescript joinFaction(faction: string): boolean; @@ -18,7 +18,7 @@ joinFaction(faction: string): boolean; | --- | --- | --- | | faction | string | Name of faction to join. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.manualhack.md b/markdown/bitburner.singularity.manualhack.md index f36865fac..078ea1e81 100644 --- a/markdown/bitburner.singularity.manualhack.md +++ b/markdown/bitburner.singularity.manualhack.md @@ -6,12 +6,12 @@ Run the hack command in the terminal. -Signature: +**Signature:** ```typescript manualHack(): Promise; ``` -Returns: +**Returns:** Promise<number> diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index bbbe3ffc3..f5a9d52af 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -6,7 +6,7 @@ Singularity API -Signature: +**Signature:** ```typescript export interface Singularity diff --git a/markdown/bitburner.singularity.purchaseaugmentation.md b/markdown/bitburner.singularity.purchaseaugmentation.md index b7d8645a4..e3d6141d9 100644 --- a/markdown/bitburner.singularity.purchaseaugmentation.md +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -6,7 +6,7 @@ Purchase an augmentation -Signature: +**Signature:** ```typescript purchaseAugmentation(faction: string, augmentation: string): boolean; @@ -19,7 +19,7 @@ purchaseAugmentation(faction: string, augmentation: string): boolean; | faction | string | Name of faction to purchase Augmentation from. | | augmentation | string | Name of Augmentation to purchase. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md index 3f1e7c4a0..f1c1a5c06 100644 --- a/markdown/bitburner.singularity.purchaseprogram.md +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -6,7 +6,7 @@ Purchase a program from the dark web. -Signature: +**Signature:** ```typescript purchaseProgram(programName: string): boolean; @@ -18,7 +18,7 @@ purchaseProgram(programName: string): boolean; | --- | --- | --- | | programName | string | Name of program to purchase. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.purchasetor.md b/markdown/bitburner.singularity.purchasetor.md index 5989ae07d..3ce2aa72c 100644 --- a/markdown/bitburner.singularity.purchasetor.md +++ b/markdown/bitburner.singularity.purchasetor.md @@ -6,12 +6,12 @@ Purchase the TOR router. -Signature: +**Signature:** ```typescript purchaseTor(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.quitjob.md b/markdown/bitburner.singularity.quitjob.md index 08ae0b937..ef11e8b18 100644 --- a/markdown/bitburner.singularity.quitjob.md +++ b/markdown/bitburner.singularity.quitjob.md @@ -6,7 +6,7 @@ Quit jobs by company. -Signature: +**Signature:** ```typescript quitJob(companyName?: string): void; @@ -16,9 +16,9 @@ quitJob(companyName?: string): void; | Parameter | Type | Description | | --- | --- | --- | -| companyName | string | Name of the company. | +| companyName | string | _(Optional)_ Name of the company. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.singularity.setfocus.md b/markdown/bitburner.singularity.setfocus.md index febb40905..dca3cffaa 100644 --- a/markdown/bitburner.singularity.setfocus.md +++ b/markdown/bitburner.singularity.setfocus.md @@ -6,7 +6,7 @@ Set the players focus. -Signature: +**Signature:** ```typescript setFocus(focus: boolean): boolean; @@ -18,7 +18,7 @@ setFocus(focus: boolean): boolean; | --- | --- | --- | | focus | boolean | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md index f55ac6dc9..d04535560 100644 --- a/markdown/bitburner.singularity.softreset.md +++ b/markdown/bitburner.singularity.softreset.md @@ -6,7 +6,7 @@ Soft reset the game. -Signature: +**Signature:** ```typescript softReset(cbScript: string): void; @@ -18,7 +18,7 @@ softReset(cbScript: string): void; | --- | --- | --- | | cbScript | string | 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: +**Returns:** void diff --git a/markdown/bitburner.singularity.stopaction.md b/markdown/bitburner.singularity.stopaction.md index b5331446e..35ea8c1e1 100644 --- a/markdown/bitburner.singularity.stopaction.md +++ b/markdown/bitburner.singularity.stopaction.md @@ -6,12 +6,12 @@ Stop the current action. -Signature: +**Signature:** ```typescript stopAction(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md index 5936c8a6a..426222dd9 100644 --- a/markdown/bitburner.singularity.traveltocity.md +++ b/markdown/bitburner.singularity.traveltocity.md @@ -6,7 +6,7 @@ Travel to another city. -Signature: +**Signature:** ```typescript travelToCity(city: CityName | `${CityName}`): boolean; @@ -18,7 +18,7 @@ travelToCity(city: CityName | `${CityName}`): boolean; | --- | --- | --- | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | City to travel to. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md index fcf4bc8e7..0388e0daf 100644 --- a/markdown/bitburner.singularity.universitycourse.md +++ b/markdown/bitburner.singularity.universitycourse.md @@ -6,7 +6,7 @@ Take university class. -Signature: +**Signature:** ```typescript universityCourse(universityName: string, courseName: string, focus?: boolean): boolean; @@ -18,9 +18,9 @@ universityCourse(universityName: string, courseName: string, focus?: boolean): b | --- | --- | --- | | universityName | string | Name of university. You must be in the correct city for whatever university you specify. | | courseName | string | Name of course. | -| focus | boolean | Acquire player focus on this class. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this class. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.upgradehomecores.md b/markdown/bitburner.singularity.upgradehomecores.md index 4351e56b5..930b942fd 100644 --- a/markdown/bitburner.singularity.upgradehomecores.md +++ b/markdown/bitburner.singularity.upgradehomecores.md @@ -6,12 +6,12 @@ Upgrade home computer cores. -Signature: +**Signature:** ```typescript upgradeHomeCores(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.upgradehomeram.md b/markdown/bitburner.singularity.upgradehomeram.md index f8f0e700d..5c638e9d1 100644 --- a/markdown/bitburner.singularity.upgradehomeram.md +++ b/markdown/bitburner.singularity.upgradehomeram.md @@ -6,12 +6,12 @@ Upgrade home computer RAM. -Signature: +**Signature:** ```typescript upgradeHomeRam(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md index 5082c9f36..67dd1598e 100644 --- a/markdown/bitburner.singularity.workforcompany.md +++ b/markdown/bitburner.singularity.workforcompany.md @@ -6,7 +6,7 @@ Work for a company. -Signature: +**Signature:** ```typescript workForCompany(companyName: string, focus?: boolean): boolean; @@ -17,9 +17,9 @@ workForCompany(companyName: string, focus?: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | | companyName | string | 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. | -| focus | boolean | Acquire player focus on this work operation. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md index ab694fa57..e6f27de2b 100644 --- a/markdown/bitburner.singularity.workforfaction.md +++ b/markdown/bitburner.singularity.workforfaction.md @@ -6,7 +6,7 @@ Work for a faction. -Signature: +**Signature:** ```typescript workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean; @@ -18,9 +18,9 @@ workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}` | --- | --- | --- | | faction | string | Name of faction to work for. | | workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | Type of work to perform for the faction. | -| focus | boolean | Acquire player focus on this work operation. Optional. Defaults to true. | +| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.skills.agility.md b/markdown/bitburner.skills.agility.md index fd430d5ee..e3a39bf39 100644 --- a/markdown/bitburner.skills.agility.md +++ b/markdown/bitburner.skills.agility.md @@ -4,7 +4,7 @@ ## Skills.agility property -Signature: +**Signature:** ```typescript agility: number; diff --git a/markdown/bitburner.skills.charisma.md b/markdown/bitburner.skills.charisma.md index 060c46db2..a89542cb6 100644 --- a/markdown/bitburner.skills.charisma.md +++ b/markdown/bitburner.skills.charisma.md @@ -4,7 +4,7 @@ ## Skills.charisma property -Signature: +**Signature:** ```typescript charisma: number; diff --git a/markdown/bitburner.skills.defense.md b/markdown/bitburner.skills.defense.md index 1a0be1730..62263fe70 100644 --- a/markdown/bitburner.skills.defense.md +++ b/markdown/bitburner.skills.defense.md @@ -4,7 +4,7 @@ ## Skills.defense property -Signature: +**Signature:** ```typescript defense: number; diff --git a/markdown/bitburner.skills.dexterity.md b/markdown/bitburner.skills.dexterity.md index 80aca09ad..001043539 100644 --- a/markdown/bitburner.skills.dexterity.md +++ b/markdown/bitburner.skills.dexterity.md @@ -4,7 +4,7 @@ ## Skills.dexterity property -Signature: +**Signature:** ```typescript dexterity: number; diff --git a/markdown/bitburner.skills.hacking.md b/markdown/bitburner.skills.hacking.md index 97b169f6e..1252a51a0 100644 --- a/markdown/bitburner.skills.hacking.md +++ b/markdown/bitburner.skills.hacking.md @@ -4,7 +4,7 @@ ## Skills.hacking property -Signature: +**Signature:** ```typescript hacking: number; diff --git a/markdown/bitburner.skills.intelligence.md b/markdown/bitburner.skills.intelligence.md index c64a3ebca..90e7a469c 100644 --- a/markdown/bitburner.skills.intelligence.md +++ b/markdown/bitburner.skills.intelligence.md @@ -4,7 +4,7 @@ ## Skills.intelligence property -Signature: +**Signature:** ```typescript intelligence: number; diff --git a/markdown/bitburner.skills.md b/markdown/bitburner.skills.md index 42d7673ef..6f12f94a7 100644 --- a/markdown/bitburner.skills.md +++ b/markdown/bitburner.skills.md @@ -5,7 +5,7 @@ ## Skills interface -Signature: +**Signature:** ```typescript interface Skills @@ -13,13 +13,13 @@ interface Skills ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agility](./bitburner.skills.agility.md) | number | | -| [charisma](./bitburner.skills.charisma.md) | number | | -| [defense](./bitburner.skills.defense.md) | number | | -| [dexterity](./bitburner.skills.dexterity.md) | number | | -| [hacking](./bitburner.skills.hacking.md) | number | | -| [intelligence](./bitburner.skills.intelligence.md) | number | | -| [strength](./bitburner.skills.strength.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agility](./bitburner.skills.agility.md) | | number | | +| [charisma](./bitburner.skills.charisma.md) | | number | | +| [defense](./bitburner.skills.defense.md) | | number | | +| [dexterity](./bitburner.skills.dexterity.md) | | number | | +| [hacking](./bitburner.skills.hacking.md) | | number | | +| [intelligence](./bitburner.skills.intelligence.md) | | number | | +| [strength](./bitburner.skills.strength.md) | | number | | diff --git a/markdown/bitburner.skills.strength.md b/markdown/bitburner.skills.strength.md index 67cda549f..49e91e304 100644 --- a/markdown/bitburner.skills.strength.md +++ b/markdown/bitburner.skills.strength.md @@ -4,7 +4,7 @@ ## Skills.strength property -Signature: +**Signature:** ```typescript strength: number; diff --git a/markdown/bitburner.skillsformulas.calculateexp.md b/markdown/bitburner.skillsformulas.calculateexp.md index bf4dd7027..36824ffd1 100644 --- a/markdown/bitburner.skillsformulas.calculateexp.md +++ b/markdown/bitburner.skillsformulas.calculateexp.md @@ -6,7 +6,7 @@ Calculate exp for skill level. -Signature: +**Signature:** ```typescript calculateExp(skill: number, skillMult?: number): number; @@ -17,9 +17,9 @@ calculateExp(skill: number, skillMult?: number): number; | Parameter | Type | Description | | --- | --- | --- | | skill | number | target skill level | -| skillMult | number | Multiplier for that skill, defaults to 1. | +| skillMult | number | _(Optional)_ Multiplier for that skill, defaults to 1. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.skillsformulas.calculateskill.md b/markdown/bitburner.skillsformulas.calculateskill.md index 09a1609d2..e4b3645bc 100644 --- a/markdown/bitburner.skillsformulas.calculateskill.md +++ b/markdown/bitburner.skillsformulas.calculateskill.md @@ -6,7 +6,7 @@ Calculate skill level. -Signature: +**Signature:** ```typescript calculateSkill(exp: number, skillMult?: number): number; @@ -17,9 +17,9 @@ calculateSkill(exp: number, skillMult?: number): number; | Parameter | Type | Description | | --- | --- | --- | | exp | number | experience for that skill | -| skillMult | number | Multiplier for that skill, defaults to 1. | +| skillMult | number | _(Optional)_ Multiplier for that skill, defaults to 1. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.skillsformulas.md b/markdown/bitburner.skillsformulas.md index 223495210..cc2ad1aa5 100644 --- a/markdown/bitburner.skillsformulas.md +++ b/markdown/bitburner.skillsformulas.md @@ -6,7 +6,7 @@ Skills formulas -Signature: +**Signature:** ```typescript interface SkillsFormulas diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md index e456fed41..b6b1f9c60 100644 --- a/markdown/bitburner.sleeve.getnumsleeves.md +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -6,12 +6,12 @@ Get the number of sleeves you own. -Signature: +**Signature:** ```typescript getNumSleeves(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.sleeve.getsleeve.md b/markdown/bitburner.sleeve.getsleeve.md index 4f8dfde26..fee90101c 100644 --- a/markdown/bitburner.sleeve.getsleeve.md +++ b/markdown/bitburner.sleeve.getsleeve.md @@ -6,7 +6,7 @@ Get information about a sleeve. -Signature: +**Signature:** ```typescript getSleeve(sleeveNumber: number): SleevePerson; @@ -18,7 +18,7 @@ getSleeve(sleeveNumber: number): SleevePerson; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to retrieve information. | -Returns: +**Returns:** [SleevePerson](./bitburner.sleeveperson.md) diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md index 387a4ee49..54110904e 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md @@ -6,7 +6,7 @@ Get price of an augmentation. -Signature: +**Signature:** ```typescript getSleeveAugmentationPrice(augName: string): number; @@ -18,7 +18,7 @@ getSleeveAugmentationPrice(augName: string): number; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md index 9fd86d7b6..625654184 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md @@ -6,7 +6,7 @@ Get reputation requirement of an augmentation. -Signature: +**Signature:** ```typescript getSleeveAugmentationRepReq(augName: string): number; @@ -18,7 +18,7 @@ getSleeveAugmentationRepReq(augName: string): number; | --- | --- | --- | | augName | string | Name of Augmentation. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md index d3835eac0..4240fee16 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentations.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -6,7 +6,7 @@ Get augmentations installed on a sleeve. -Signature: +**Signature:** ```typescript getSleeveAugmentations(sleeveNumber: number): string[]; @@ -18,7 +18,7 @@ getSleeveAugmentations(sleeveNumber: number): string[]; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to retrieve augmentations from. | -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md index b4c635a4f..34ee999c6 100644 --- a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -6,7 +6,7 @@ List purchasable augs for a sleeve. -Signature: +**Signature:** ```typescript getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; @@ -18,7 +18,7 @@ getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to retrieve purchasable augmentations from. | -Returns: +**Returns:** [AugmentPair](./bitburner.augmentpair.md)\[\] diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md index 11fec4014..890636b8c 100644 --- a/markdown/bitburner.sleeve.gettask.md +++ b/markdown/bitburner.sleeve.gettask.md @@ -6,7 +6,7 @@ Get task of a sleeve. -Signature: +**Signature:** ```typescript getTask(sleeveNumber: number): SleeveTask | null; @@ -18,7 +18,7 @@ getTask(sleeveNumber: number): SleeveTask | null; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to retrieve task from. | -Returns: +**Returns:** [SleeveTask](./bitburner.sleevetask.md) \| null diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index 28040a996..17107a3b5 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -6,7 +6,7 @@ Sleeve API -Signature: +**Signature:** ```typescript export interface Sleeve diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md index 16d6f836a..423a23d0e 100644 --- a/markdown/bitburner.sleeve.purchasesleeveaug.md +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -6,7 +6,7 @@ Purchase an aug for a sleeve. -Signature: +**Signature:** ```typescript purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; @@ -19,7 +19,7 @@ purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; | sleeveNumber | number | Index of the sleeve to buy an aug for. | | augName | string | Name of the aug to buy. Must be an exact match. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md index 3d9bf246c..96b8cc734 100644 --- a/markdown/bitburner.sleeve.settobladeburneraction.md +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -6,7 +6,7 @@ Set a sleeve to perform bladeburner actions. -Signature: +**Signature:** ```typescript setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean; @@ -18,9 +18,9 @@ setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to workout at the gym. | | action | string | Name of the action to be performed. | -| contract | string | Name of the contract if applicable. | +| contract | string | _(Optional)_ Name of the contract if applicable. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index 835be4e00..5d0c07fa8 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -6,7 +6,7 @@ Set a sleeve to commit crime. -Signature: +**Signature:** ```typescript setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean; @@ -19,7 +19,7 @@ setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): b | sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. | | crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index bc8d93a0d..72691b7c9 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -6,7 +6,7 @@ Set a sleeve to work for a company. -Signature: +**Signature:** ```typescript setToCompanyWork(sleeveNumber: number, companyName: string): boolean; @@ -19,7 +19,7 @@ setToCompanyWork(sleeveNumber: number, companyName: string): boolean; | sleeveNumber | number | Index of the sleeve to work for the company. | | companyName | string | Name of the company to work for. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index 2d5b6ea17..f6d4b0619 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -6,7 +6,7 @@ Set a sleeve to work for a faction. -Signature: +**Signature:** ```typescript setToFactionWork( @@ -24,7 +24,7 @@ setToFactionWork( | factionName | string | Name of the faction to work for. | | factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | Name of the action to perform for this faction. | -Returns: +**Returns:** boolean \| undefined diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md index b092838eb..07ee824c9 100644 --- a/markdown/bitburner.sleeve.settogymworkout.md +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -6,7 +6,7 @@ Set a sleeve to workout at the gym. -Signature: +**Signature:** ```typescript setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; @@ -20,7 +20,7 @@ setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; | gymName | string | Name of the gym. | | stat | string | Name of the stat to train. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md index 93a1ef01c..07f1bb891 100644 --- a/markdown/bitburner.sleeve.settoshockrecovery.md +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -6,7 +6,7 @@ Set a sleeve to shock recovery. -Signature: +**Signature:** ```typescript setToShockRecovery(sleeveNumber: number): boolean; @@ -18,7 +18,7 @@ setToShockRecovery(sleeveNumber: number): boolean; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start recovery. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md index 17fa4ca6d..2c44e74f3 100644 --- a/markdown/bitburner.sleeve.settosynchronize.md +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -6,7 +6,7 @@ Set a sleeve to synchronize. -Signature: +**Signature:** ```typescript setToSynchronize(sleeveNumber: number): boolean; @@ -18,7 +18,7 @@ setToSynchronize(sleeveNumber: number): boolean; | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start synchronizing. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md index f96d60a8b..9fcf24ceb 100644 --- a/markdown/bitburner.sleeve.settouniversitycourse.md +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -6,7 +6,7 @@ Set a sleeve to take a class at a university. -Signature: +**Signature:** ```typescript setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean; @@ -20,7 +20,7 @@ setToUniversityCourse(sleeveNumber: number, university: string, className: strin | university | string | Name of the university to attend. | | className | string | Name of the class to follow. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index 8ff1d85cb..3b3c18b82 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -6,7 +6,7 @@ Make a sleeve travel to another city. -Signature: +**Signature:** ```typescript travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; @@ -19,7 +19,7 @@ travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; | sleeveNumber | number | Index of the sleeve to travel. | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the destination city. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.sleevebladeburnertask.md b/markdown/bitburner.sleevebladeburnertask.md index 62bbd4193..798bab62e 100644 --- a/markdown/bitburner.sleevebladeburnertask.md +++ b/markdown/bitburner.sleevebladeburnertask.md @@ -5,12 +5,13 @@ ## SleeveBladeburnerTask type -Signature: +**Signature:** ```typescript type SleeveBladeburnerTask = { type: "BLADEBURNER"; actionType: "General" | "Contracts"; actionName: string; + cyclesWorked: number; }; ``` diff --git a/markdown/bitburner.sleeveclasstask.md b/markdown/bitburner.sleeveclasstask.md index 304d374b6..b39475abc 100644 --- a/markdown/bitburner.sleeveclasstask.md +++ b/markdown/bitburner.sleeveclasstask.md @@ -5,7 +5,7 @@ ## SleeveClassTask type -Signature: +**Signature:** ```typescript type SleeveClassTask = { @@ -14,5 +14,5 @@ type SleeveClassTask = { location: LocationName | `${LocationName}`; }; ``` -References: [UniversityClassType](./bitburner.universityclasstype.md), [GymType](./bitburner.gymtype.md), [LocationName](./bitburner.locationname.md) +**References:** [UniversityClassType](./bitburner.universityclasstype.md), [GymType](./bitburner.gymtype.md), [LocationName](./bitburner.locationname.md) diff --git a/markdown/bitburner.sleevecompanytask.md b/markdown/bitburner.sleevecompanytask.md index 97ec5c680..58b869626 100644 --- a/markdown/bitburner.sleevecompanytask.md +++ b/markdown/bitburner.sleevecompanytask.md @@ -5,7 +5,7 @@ ## SleeveCompanyTask type -Signature: +**Signature:** ```typescript type SleeveCompanyTask = { type: "COMPANY"; companyName: string }; diff --git a/markdown/bitburner.sleevecrimetask.md b/markdown/bitburner.sleevecrimetask.md index f23063f3e..e4ef12182 100644 --- a/markdown/bitburner.sleevecrimetask.md +++ b/markdown/bitburner.sleevecrimetask.md @@ -5,10 +5,10 @@ ## SleeveCrimeTask type -Signature: +**Signature:** ```typescript -type SleeveCrimeTask = { type: "CRIME"; crimeType: CrimeType | `${CrimeType}` }; +type SleeveCrimeTask = { type: "CRIME"; crimeType: CrimeType | `${CrimeType}`; cyclesWorked: number }; ``` -References: [CrimeType](./bitburner.crimetype.md) +**References:** [CrimeType](./bitburner.crimetype.md) diff --git a/markdown/bitburner.sleevefactiontask.md b/markdown/bitburner.sleevefactiontask.md index 132ca9e62..e24a57b1e 100644 --- a/markdown/bitburner.sleevefactiontask.md +++ b/markdown/bitburner.sleevefactiontask.md @@ -5,7 +5,7 @@ ## SleeveFactionTask type -Signature: +**Signature:** ```typescript type SleeveFactionTask = { @@ -14,5 +14,5 @@ type SleeveFactionTask = { factionName: string; }; ``` -References: [FactionWorkType](./bitburner.factionworktype.md) +**References:** [FactionWorkType](./bitburner.factionworktype.md) diff --git a/markdown/bitburner.sleeveinfiltratetask.md b/markdown/bitburner.sleeveinfiltratetask.md index 4e46e3861..c4076cbc3 100644 --- a/markdown/bitburner.sleeveinfiltratetask.md +++ b/markdown/bitburner.sleeveinfiltratetask.md @@ -5,8 +5,8 @@ ## SleeveInfiltrateTask type -Signature: +**Signature:** ```typescript -type SleeveInfiltrateTask = { type: "INFILTRATE" }; +type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number }; ``` diff --git a/markdown/bitburner.sleeveperson.md b/markdown/bitburner.sleeveperson.md index bdc651570..7454801e4 100644 --- a/markdown/bitburner.sleeveperson.md +++ b/markdown/bitburner.sleeveperson.md @@ -5,19 +5,19 @@ ## SleevePerson interface -Signature: +**Signature:** ```typescript interface SleevePerson extends Person ``` -Extends: [Person](./bitburner.person.md) +**Extends:** [Person](./bitburner.person.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [memory](./bitburner.sleeveperson.memory.md) | number | Number 1-100 initial Value of sync on BN start | -| [shock](./bitburner.sleeveperson.shock.md) | number | Number 0-100 Experience earned and shared is multiplied with shock% before sync% | -| [storedCycles](./bitburner.sleeveperson.storedcycles.md) | number | Number of 200ms cycles which are stored as bonus time | -| [sync](./bitburner.sleeveperson.sync.md) | number | Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [memory](./bitburner.sleeveperson.memory.md) | | number | Number 1-100 initial Value of sync on BN start | +| [shock](./bitburner.sleeveperson.shock.md) | | number | Number 0-100 Experience earned and shared is multiplied with shock% before sync% | +| [storedCycles](./bitburner.sleeveperson.storedcycles.md) | | number | Number of 200ms cycles which are stored as bonus time | +| [sync](./bitburner.sleeveperson.sync.md) | | number | Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% | diff --git a/markdown/bitburner.sleeveperson.memory.md b/markdown/bitburner.sleeveperson.memory.md index 5b13f1f3d..1f5758a76 100644 --- a/markdown/bitburner.sleeveperson.memory.md +++ b/markdown/bitburner.sleeveperson.memory.md @@ -6,7 +6,7 @@ Number 1-100 initial Value of sync on BN start -Signature: +**Signature:** ```typescript memory: number; diff --git a/markdown/bitburner.sleeveperson.shock.md b/markdown/bitburner.sleeveperson.shock.md index 9acfc5b4e..c3a404b10 100644 --- a/markdown/bitburner.sleeveperson.shock.md +++ b/markdown/bitburner.sleeveperson.shock.md @@ -6,7 +6,7 @@ Number 0-100 Experience earned and shared is multiplied with shock% before sync% -Signature: +**Signature:** ```typescript shock: number; diff --git a/markdown/bitburner.sleeveperson.storedcycles.md b/markdown/bitburner.sleeveperson.storedcycles.md index d487359a9..d61915b9e 100644 --- a/markdown/bitburner.sleeveperson.storedcycles.md +++ b/markdown/bitburner.sleeveperson.storedcycles.md @@ -6,7 +6,7 @@ Number of 200ms cycles which are stored as bonus time -Signature: +**Signature:** ```typescript storedCycles: number; diff --git a/markdown/bitburner.sleeveperson.sync.md b/markdown/bitburner.sleeveperson.sync.md index daeca7948..af186ee2b 100644 --- a/markdown/bitburner.sleeveperson.sync.md +++ b/markdown/bitburner.sleeveperson.sync.md @@ -6,7 +6,7 @@ Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% -Signature: +**Signature:** ```typescript sync: number; diff --git a/markdown/bitburner.sleeverecoverytask.md b/markdown/bitburner.sleeverecoverytask.md index 8a17033c0..f846b6835 100644 --- a/markdown/bitburner.sleeverecoverytask.md +++ b/markdown/bitburner.sleeverecoverytask.md @@ -5,7 +5,7 @@ ## SleeveRecoveryTask type -Signature: +**Signature:** ```typescript type SleeveRecoveryTask = { type: "RECOVERY" }; diff --git a/markdown/bitburner.sleevesupporttask.md b/markdown/bitburner.sleevesupporttask.md index d1df450d8..6507ecc30 100644 --- a/markdown/bitburner.sleevesupporttask.md +++ b/markdown/bitburner.sleevesupporttask.md @@ -5,7 +5,7 @@ ## SleeveSupportTask type -Signature: +**Signature:** ```typescript type SleeveSupportTask = { type: "SUPPORT" }; diff --git a/markdown/bitburner.sleevesynchrotask.md b/markdown/bitburner.sleevesynchrotask.md index ef4b49f7b..83e09684c 100644 --- a/markdown/bitburner.sleevesynchrotask.md +++ b/markdown/bitburner.sleevesynchrotask.md @@ -5,7 +5,7 @@ ## SleeveSynchroTask type -Signature: +**Signature:** ```typescript type SleeveSynchroTask = { type: "SYNCHRO" }; diff --git a/markdown/bitburner.sleevetask.md b/markdown/bitburner.sleevetask.md index d1ff3086f..b5bbf60fd 100644 --- a/markdown/bitburner.sleevetask.md +++ b/markdown/bitburner.sleevetask.md @@ -6,7 +6,7 @@ Object representing a sleeve current task. -Signature: +**Signature:** ```typescript export type SleeveTask = @@ -20,5 +20,5 @@ export type SleeveTask = | SleeveSupportTask | SleeveSynchroTask; ``` -References: [SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md), [SleeveClassTask](./bitburner.sleeveclasstask.md), [SleeveCompanyTask](./bitburner.sleevecompanytask.md), [SleeveCrimeTask](./bitburner.sleevecrimetask.md), [SleeveFactionTask](./bitburner.sleevefactiontask.md), [SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md), [SleeveRecoveryTask](./bitburner.sleeverecoverytask.md), [SleeveSupportTask](./bitburner.sleevesupporttask.md), [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) +**References:** [SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md), [SleeveClassTask](./bitburner.sleeveclasstask.md), [SleeveCompanyTask](./bitburner.sleevecompanytask.md), [SleeveCrimeTask](./bitburner.sleevecrimetask.md), [SleeveFactionTask](./bitburner.sleevefactiontask.md), [SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md), [SleeveRecoveryTask](./bitburner.sleeverecoverytask.md), [SleeveSupportTask](./bitburner.sleevesupporttask.md), [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) diff --git a/markdown/bitburner.sourcefilelvl.lvl.md b/markdown/bitburner.sourcefilelvl.lvl.md index 067dd01ce..8660efbb8 100644 --- a/markdown/bitburner.sourcefilelvl.lvl.md +++ b/markdown/bitburner.sourcefilelvl.lvl.md @@ -6,7 +6,7 @@ The level of the source file -Signature: +**Signature:** ```typescript lvl: number; diff --git a/markdown/bitburner.sourcefilelvl.md b/markdown/bitburner.sourcefilelvl.md index ca986ed8b..65b0731c8 100644 --- a/markdown/bitburner.sourcefilelvl.md +++ b/markdown/bitburner.sourcefilelvl.md @@ -5,7 +5,7 @@ ## SourceFileLvl interface -Signature: +**Signature:** ```typescript interface SourceFileLvl @@ -13,8 +13,8 @@ interface SourceFileLvl ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [lvl](./bitburner.sourcefilelvl.lvl.md) | number | The level of the source file | -| [n](./bitburner.sourcefilelvl.n.md) | number | The number of the source file | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [lvl](./bitburner.sourcefilelvl.lvl.md) | | number | The level of the source file | +| [n](./bitburner.sourcefilelvl.n.md) | | number | The number of the source file | diff --git a/markdown/bitburner.sourcefilelvl.n.md b/markdown/bitburner.sourcefilelvl.n.md index 46ffb9ed9..cfa1645fd 100644 --- a/markdown/bitburner.sourcefilelvl.n.md +++ b/markdown/bitburner.sourcefilelvl.n.md @@ -6,7 +6,7 @@ The number of the source file -Signature: +**Signature:** ```typescript n: number; diff --git a/markdown/bitburner.stanek.acceptgift.md b/markdown/bitburner.stanek.acceptgift.md index a3bb3dde0..833186bf4 100644 --- a/markdown/bitburner.stanek.acceptgift.md +++ b/markdown/bitburner.stanek.acceptgift.md @@ -6,12 +6,12 @@ Accept Stanek's Gift by joining the Church of the Machine God -Signature: +**Signature:** ```typescript acceptGift(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.stanek.activefragments.md b/markdown/bitburner.stanek.activefragments.md index cbdd74f25..94b205bf8 100644 --- a/markdown/bitburner.stanek.activefragments.md +++ b/markdown/bitburner.stanek.activefragments.md @@ -6,12 +6,12 @@ List of fragments in Stanek's Gift. -Signature: +**Signature:** ```typescript activeFragments(): ActiveFragment[]; ``` -Returns: +**Returns:** [ActiveFragment](./bitburner.activefragment.md)\[\] diff --git a/markdown/bitburner.stanek.canplacefragment.md b/markdown/bitburner.stanek.canplacefragment.md index 4f06ba218..f5f9e2f22 100644 --- a/markdown/bitburner.stanek.canplacefragment.md +++ b/markdown/bitburner.stanek.canplacefragment.md @@ -6,7 +6,7 @@ Check if fragment can be placed at specified location. -Signature: +**Signature:** ```typescript canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; @@ -21,7 +21,7 @@ canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: num | rotation | number | rotation A number from 0 to 3, the mount of 90 degree turn to take. | | fragmentId | number | fragmentId ID of the fragment to place. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.stanek.chargefragment.md b/markdown/bitburner.stanek.chargefragment.md index 9b3e75a72..1d1ca2771 100644 --- a/markdown/bitburner.stanek.chargefragment.md +++ b/markdown/bitburner.stanek.chargefragment.md @@ -6,7 +6,7 @@ Charge a fragment, increasing its power. -Signature: +**Signature:** ```typescript chargeFragment(rootX: number, rootY: number): Promise; @@ -19,7 +19,7 @@ chargeFragment(rootX: number, rootY: number): Promise; | rootX | number | rootX Root X against which to align the top left of the fragment. | | rootY | number | rootY Root Y against which to align the top left of the fragment. | -Returns: +**Returns:** Promise<void> diff --git a/markdown/bitburner.stanek.cleargift.md b/markdown/bitburner.stanek.cleargift.md index 12ece8a3d..d3269bd52 100644 --- a/markdown/bitburner.stanek.cleargift.md +++ b/markdown/bitburner.stanek.cleargift.md @@ -6,12 +6,12 @@ Clear the board of all fragments. -Signature: +**Signature:** ```typescript clearGift(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.stanek.fragmentdefinitions.md b/markdown/bitburner.stanek.fragmentdefinitions.md index dbc36f456..b18b7148d 100644 --- a/markdown/bitburner.stanek.fragmentdefinitions.md +++ b/markdown/bitburner.stanek.fragmentdefinitions.md @@ -6,12 +6,12 @@ List possible fragments. -Signature: +**Signature:** ```typescript fragmentDefinitions(): Fragment[]; ``` -Returns: +**Returns:** [Fragment](./bitburner.fragment.md)\[\] diff --git a/markdown/bitburner.stanek.getfragment.md b/markdown/bitburner.stanek.getfragment.md index 348c23d37..7430b753d 100644 --- a/markdown/bitburner.stanek.getfragment.md +++ b/markdown/bitburner.stanek.getfragment.md @@ -6,7 +6,7 @@ Get placed fragment at location. -Signature: +**Signature:** ```typescript getFragment(rootX: number, rootY: number): ActiveFragment | undefined; @@ -19,7 +19,7 @@ getFragment(rootX: number, rootY: number): ActiveFragment | undefined; | rootX | number | X against which to align the top left of the fragment. | | rootY | number | Y against which to align the top left of the fragment. | -Returns: +**Returns:** [ActiveFragment](./bitburner.activefragment.md) \| undefined diff --git a/markdown/bitburner.stanek.giftheight.md b/markdown/bitburner.stanek.giftheight.md index 6ce12a20a..1e3531fda 100644 --- a/markdown/bitburner.stanek.giftheight.md +++ b/markdown/bitburner.stanek.giftheight.md @@ -6,12 +6,12 @@ Stanek's Gift height. -Signature: +**Signature:** ```typescript giftHeight(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.stanek.giftwidth.md b/markdown/bitburner.stanek.giftwidth.md index aa85b25c2..7467c52ae 100644 --- a/markdown/bitburner.stanek.giftwidth.md +++ b/markdown/bitburner.stanek.giftwidth.md @@ -6,12 +6,12 @@ Stanek's Gift width. -Signature: +**Signature:** ```typescript giftWidth(): number; ``` -Returns: +**Returns:** number diff --git a/markdown/bitburner.stanek.md b/markdown/bitburner.stanek.md index 0a518d780..8717576b0 100644 --- a/markdown/bitburner.stanek.md +++ b/markdown/bitburner.stanek.md @@ -6,7 +6,7 @@ Stanek's Gift API. -Signature: +**Signature:** ```typescript interface Stanek diff --git a/markdown/bitburner.stanek.placefragment.md b/markdown/bitburner.stanek.placefragment.md index 4ff6495c4..19d13fefd 100644 --- a/markdown/bitburner.stanek.placefragment.md +++ b/markdown/bitburner.stanek.placefragment.md @@ -6,7 +6,7 @@ Place fragment on Stanek's Gift. -Signature: +**Signature:** ```typescript placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; @@ -21,7 +21,7 @@ placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number | rotation | number | A number from 0 to 3, the mount of 90 degree turn to take. | | fragmentId | number | ID of the fragment to place. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.stanek.removefragment.md b/markdown/bitburner.stanek.removefragment.md index 63071dd20..7d31389f1 100644 --- a/markdown/bitburner.stanek.removefragment.md +++ b/markdown/bitburner.stanek.removefragment.md @@ -6,7 +6,7 @@ Remove fragment at location. -Signature: +**Signature:** ```typescript removeFragment(rootX: number, rootY: number): boolean; @@ -19,7 +19,7 @@ removeFragment(rootX: number, rootY: number): boolean; | rootX | number | X against which to align the top left of the fragment. | | rootY | number | Y against which to align the top left of the fragment. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md index 1c5b3d981..56a458021 100644 --- a/markdown/bitburner.stockorder.md +++ b/markdown/bitburner.stockorder.md @@ -8,7 +8,7 @@ Return value of [getOrders](./bitburner.tix.getorders.md) Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) -Signature: +**Signature:** ```typescript interface StockOrder diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md index c8a0a44f5..4e894b1af 100644 --- a/markdown/bitburner.stockorderobject.md +++ b/markdown/bitburner.stockorderobject.md @@ -6,7 +6,7 @@ Value in map of [StockOrder](./bitburner.stockorder.md) -Signature: +**Signature:** ```typescript interface StockOrderObject @@ -14,10 +14,10 @@ interface StockOrderObject ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [position](./bitburner.stockorderobject.position.md) | [PositionTypes](./bitburner.positiontypes.md) | 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) | [OrderTypes](./bitburner.ordertypes.md) | Order type | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [position](./bitburner.stockorderobject.position.md) | | [PositionTypes](./bitburner.positiontypes.md) | 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) | | [OrderTypes](./bitburner.ordertypes.md) | Order type | diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md index 9f6aac1de..cdf0c2fce 100644 --- a/markdown/bitburner.stockorderobject.position.md +++ b/markdown/bitburner.stockorderobject.position.md @@ -6,7 +6,7 @@ Order position -Signature: +**Signature:** ```typescript position: PositionTypes; diff --git a/markdown/bitburner.stockorderobject.price.md b/markdown/bitburner.stockorderobject.price.md index 8c96a4820..3fd027f2c 100644 --- a/markdown/bitburner.stockorderobject.price.md +++ b/markdown/bitburner.stockorderobject.price.md @@ -6,7 +6,7 @@ Price per share -Signature: +**Signature:** ```typescript price: number; diff --git a/markdown/bitburner.stockorderobject.shares.md b/markdown/bitburner.stockorderobject.shares.md index 6553ff33c..0816130d2 100644 --- a/markdown/bitburner.stockorderobject.shares.md +++ b/markdown/bitburner.stockorderobject.shares.md @@ -6,7 +6,7 @@ Number of shares -Signature: +**Signature:** ```typescript shares: number; diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md index 59c3258ef..00cffde00 100644 --- a/markdown/bitburner.stockorderobject.type.md +++ b/markdown/bitburner.stockorderobject.type.md @@ -6,7 +6,7 @@ Order type -Signature: +**Signature:** ```typescript type: OrderTypes; diff --git a/markdown/bitburner.tix.buyshort.md b/markdown/bitburner.tix.buyshort.md index 77e928662..a9fc49b64 100644 --- a/markdown/bitburner.tix.buyshort.md +++ b/markdown/bitburner.tix.buyshort.md @@ -6,7 +6,7 @@ Short stocks. -Signature: +**Signature:** ```typescript buyShort(sym: string, shares: number): number; @@ -19,7 +19,7 @@ buyShort(sym: string, shares: number): number; | sym | string | Stock symbol. | | shares | number | Number of shares to short. Must be positive. Will be rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.buystock.md b/markdown/bitburner.tix.buystock.md index 5a8e8b56c..235c3f280 100644 --- a/markdown/bitburner.tix.buystock.md +++ b/markdown/bitburner.tix.buystock.md @@ -6,7 +6,7 @@ Buy stocks. -Signature: +**Signature:** ```typescript buyStock(sym: string, shares: number): number; @@ -19,7 +19,7 @@ buyStock(sym: string, shares: number): number; | sym | string | Stock symbol. | | shares | number | Number of shares to purchased. Must be positive. Will be rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md index c5ef90cb8..b619296be 100644 --- a/markdown/bitburner.tix.cancelorder.md +++ b/markdown/bitburner.tix.cancelorder.md @@ -6,7 +6,7 @@ Cancel order for stocks. -Signature: +**Signature:** ```typescript cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void; @@ -22,7 +22,7 @@ cancelOrder(sym: string, shares: number, price: number, type: string, pos: strin | type | string | Type of order. | | pos | string | Specifies whether the order is a “Long” or “Short” position. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.tix.getaskprice.md b/markdown/bitburner.tix.getaskprice.md index 1f33c26cd..f78b40e2f 100644 --- a/markdown/bitburner.tix.getaskprice.md +++ b/markdown/bitburner.tix.getaskprice.md @@ -6,7 +6,7 @@ Returns the ask price of that stock. -Signature: +**Signature:** ```typescript getAskPrice(sym: string): number; @@ -18,7 +18,7 @@ getAskPrice(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getbidprice.md b/markdown/bitburner.tix.getbidprice.md index a2d00d8b1..bcebd8ff3 100644 --- a/markdown/bitburner.tix.getbidprice.md +++ b/markdown/bitburner.tix.getbidprice.md @@ -6,7 +6,7 @@ Returns the bid price of that stock. -Signature: +**Signature:** ```typescript getBidPrice(sym: string): number; @@ -18,7 +18,7 @@ getBidPrice(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getforecast.md b/markdown/bitburner.tix.getforecast.md index 4fa0c0043..507980222 100644 --- a/markdown/bitburner.tix.getforecast.md +++ b/markdown/bitburner.tix.getforecast.md @@ -6,7 +6,7 @@ Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. -Signature: +**Signature:** ```typescript getForecast(sym: string): number; @@ -18,7 +18,7 @@ getForecast(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getmaxshares.md b/markdown/bitburner.tix.getmaxshares.md index ec152466f..0715ec4d3 100644 --- a/markdown/bitburner.tix.getmaxshares.md +++ b/markdown/bitburner.tix.getmaxshares.md @@ -6,7 +6,7 @@ Returns the maximum number of shares of a stock. -Signature: +**Signature:** ```typescript getMaxShares(sym: string): number; @@ -18,7 +18,7 @@ getMaxShares(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getorders.md b/markdown/bitburner.tix.getorders.md index 04184a956..376f4cf70 100644 --- a/markdown/bitburner.tix.getorders.md +++ b/markdown/bitburner.tix.getorders.md @@ -6,12 +6,12 @@ Returns your order book for the stock market. -Signature: +**Signature:** ```typescript getOrders(): StockOrder; ``` -Returns: +**Returns:** [StockOrder](./bitburner.stockorder.md) diff --git a/markdown/bitburner.tix.getorganization.md b/markdown/bitburner.tix.getorganization.md index 59b7b689a..3b16a4463 100644 --- a/markdown/bitburner.tix.getorganization.md +++ b/markdown/bitburner.tix.getorganization.md @@ -6,7 +6,7 @@ Returns the organization associated with a stock symbol. -Signature: +**Signature:** ```typescript getOrganization(sym: string): string; @@ -18,7 +18,7 @@ getOrganization(sym: string): string; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** string diff --git a/markdown/bitburner.tix.getposition.md b/markdown/bitburner.tix.getposition.md index 206fcb2a8..ed7db96ba 100644 --- a/markdown/bitburner.tix.getposition.md +++ b/markdown/bitburner.tix.getposition.md @@ -6,7 +6,7 @@ Returns the player’s position in a stock. -Signature: +**Signature:** ```typescript getPosition(sym: string): [number, number, number, number]; @@ -18,7 +18,7 @@ getPosition(sym: string): [number, number, number, number]; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** \[number, number, number, number\] diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md index 6c199342a..08bed6761 100644 --- a/markdown/bitburner.tix.getprice.md +++ b/markdown/bitburner.tix.getprice.md @@ -6,7 +6,7 @@ Returns the price of a stock. -Signature: +**Signature:** ```typescript getPrice(sym: string): number; @@ -18,7 +18,7 @@ getPrice(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getpurchasecost.md b/markdown/bitburner.tix.getpurchasecost.md index 7eb12f88c..029342b7b 100644 --- a/markdown/bitburner.tix.getpurchasecost.md +++ b/markdown/bitburner.tix.getpurchasecost.md @@ -6,7 +6,7 @@ Calculates cost of buying stocks. -Signature: +**Signature:** ```typescript getPurchaseCost(sym: string, shares: number, posType: string): number; @@ -20,7 +20,7 @@ getPurchaseCost(sym: string, shares: number, posType: string): number; | shares | number | Number of shares to purchase. | | posType | string | Specifies whether the order is a “Long” or “Short” position. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getsalegain.md b/markdown/bitburner.tix.getsalegain.md index bbc263f28..ddd969301 100644 --- a/markdown/bitburner.tix.getsalegain.md +++ b/markdown/bitburner.tix.getsalegain.md @@ -6,7 +6,7 @@ Calculate profit of selling stocks. -Signature: +**Signature:** ```typescript getSaleGain(sym: string, shares: number, posType: string): number; @@ -20,7 +20,7 @@ getSaleGain(sym: string, shares: number, posType: string): number; | shares | number | Number of shares to sell. | | posType | string | Specifies whether the order is a “Long” or “Short” position. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.getsymbols.md b/markdown/bitburner.tix.getsymbols.md index 8ec52e5d9..164d0b6fd 100644 --- a/markdown/bitburner.tix.getsymbols.md +++ b/markdown/bitburner.tix.getsymbols.md @@ -6,12 +6,12 @@ Returns an array of the symbols of the tradable stocks -Signature: +**Signature:** ```typescript getSymbols(): string[]; ``` -Returns: +**Returns:** string\[\] diff --git a/markdown/bitburner.tix.getvolatility.md b/markdown/bitburner.tix.getvolatility.md index b38afb066..1500e316f 100644 --- a/markdown/bitburner.tix.getvolatility.md +++ b/markdown/bitburner.tix.getvolatility.md @@ -6,7 +6,7 @@ Returns the volatility of the specified stock. -Signature: +**Signature:** ```typescript getVolatility(sym: string): number; @@ -18,7 +18,7 @@ getVolatility(sym: string): number; | --- | --- | --- | | sym | string | Stock symbol. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.has4sdata.md b/markdown/bitburner.tix.has4sdata.md index 65ee2a131..2a8aeb689 100644 --- a/markdown/bitburner.tix.has4sdata.md +++ b/markdown/bitburner.tix.has4sdata.md @@ -6,12 +6,12 @@ Returns true if the player has access to the 4S Data -Signature: +**Signature:** ```typescript has4SData(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.has4sdatatixapi.md b/markdown/bitburner.tix.has4sdatatixapi.md index f3d55d9b0..a982646d2 100644 --- a/markdown/bitburner.tix.has4sdatatixapi.md +++ b/markdown/bitburner.tix.has4sdatatixapi.md @@ -6,12 +6,12 @@ Returns true if the player has access to the 4SData TIX API -Signature: +**Signature:** ```typescript has4SDataTIXAPI(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.hastixapiaccess.md b/markdown/bitburner.tix.hastixapiaccess.md index 083bbd038..39940f911 100644 --- a/markdown/bitburner.tix.hastixapiaccess.md +++ b/markdown/bitburner.tix.hastixapiaccess.md @@ -6,12 +6,12 @@ Returns true if the player has access to the TIX API -Signature: +**Signature:** ```typescript hasTIXAPIAccess(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.haswseaccount.md b/markdown/bitburner.tix.haswseaccount.md index d823ab064..6b5c18a4a 100644 --- a/markdown/bitburner.tix.haswseaccount.md +++ b/markdown/bitburner.tix.haswseaccount.md @@ -6,12 +6,12 @@ Returns true if the player has access to a WSE Account -Signature: +**Signature:** ```typescript hasWSEAccount(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.md b/markdown/bitburner.tix.md index 2eaf58741..8c418eed2 100644 --- a/markdown/bitburner.tix.md +++ b/markdown/bitburner.tix.md @@ -6,7 +6,7 @@ Stock market API -Signature: +**Signature:** ```typescript export interface TIX diff --git a/markdown/bitburner.tix.placeorder.md b/markdown/bitburner.tix.placeorder.md index 59a9cba98..b3cc558a6 100644 --- a/markdown/bitburner.tix.placeorder.md +++ b/markdown/bitburner.tix.placeorder.md @@ -6,7 +6,7 @@ Place order for stocks. -Signature: +**Signature:** ```typescript placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean; @@ -22,7 +22,7 @@ placeOrder(sym: string, shares: number, price: number, type: string, pos: string | type | string | Type of order. | | pos | string | Specifies whether the order is a “Long” or “Short” position. | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.purchase4smarketdata.md b/markdown/bitburner.tix.purchase4smarketdata.md index 42b21a322..0dd875fc8 100644 --- a/markdown/bitburner.tix.purchase4smarketdata.md +++ b/markdown/bitburner.tix.purchase4smarketdata.md @@ -6,12 +6,12 @@ Purchase 4S Market Data Access. -Signature: +**Signature:** ```typescript purchase4SMarketData(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.purchase4smarketdatatixapi.md b/markdown/bitburner.tix.purchase4smarketdatatixapi.md index c23ebd346..3441fdd6a 100644 --- a/markdown/bitburner.tix.purchase4smarketdatatixapi.md +++ b/markdown/bitburner.tix.purchase4smarketdatatixapi.md @@ -6,12 +6,12 @@ Purchase 4S Market Data TIX API Access. -Signature: +**Signature:** ```typescript purchase4SMarketDataTixApi(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.purchasetixapi.md b/markdown/bitburner.tix.purchasetixapi.md index ed42a91be..274bdadde 100644 --- a/markdown/bitburner.tix.purchasetixapi.md +++ b/markdown/bitburner.tix.purchasetixapi.md @@ -6,12 +6,12 @@ Purchase TIX API Access -Signature: +**Signature:** ```typescript purchaseTixApi(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.purchasewseaccount.md b/markdown/bitburner.tix.purchasewseaccount.md index ec18792d5..b88f261f3 100644 --- a/markdown/bitburner.tix.purchasewseaccount.md +++ b/markdown/bitburner.tix.purchasewseaccount.md @@ -6,12 +6,12 @@ Purchase WSE Account. -Signature: +**Signature:** ```typescript purchaseWseAccount(): boolean; ``` -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.tix.sellshort.md b/markdown/bitburner.tix.sellshort.md index f5081991a..acbfa2a70 100644 --- a/markdown/bitburner.tix.sellshort.md +++ b/markdown/bitburner.tix.sellshort.md @@ -6,7 +6,7 @@ Sell short stock. -Signature: +**Signature:** ```typescript sellShort(sym: string, shares: number): number; @@ -19,7 +19,7 @@ sellShort(sym: string, shares: number): number; | sym | string | Stock symbol. | | shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.tix.sellstock.md b/markdown/bitburner.tix.sellstock.md index 7d18b72c7..196462f0c 100644 --- a/markdown/bitburner.tix.sellstock.md +++ b/markdown/bitburner.tix.sellstock.md @@ -6,7 +6,7 @@ Sell stocks. -Signature: +**Signature:** ```typescript sellStock(sym: string, shares: number): number; @@ -19,7 +19,7 @@ sellStock(sym: string, shares: number): number; | sym | string | Stock symbol. | | shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | -Returns: +**Returns:** number diff --git a/markdown/bitburner.toastvariant.md b/markdown/bitburner.toastvariant.md index 6e0675aee..1bcd5aed3 100644 --- a/markdown/bitburner.toastvariant.md +++ b/markdown/bitburner.toastvariant.md @@ -5,7 +5,7 @@ ## ToastVariant enum -Signature: +**Signature:** ```typescript declare enum ToastVariant diff --git a/markdown/bitburner.universityclasstype.md b/markdown/bitburner.universityclasstype.md index 50700a8eb..61157181e 100644 --- a/markdown/bitburner.universityclasstype.md +++ b/markdown/bitburner.universityclasstype.md @@ -5,7 +5,7 @@ ## UniversityClassType enum -Signature: +**Signature:** ```typescript declare enum UniversityClassType diff --git a/markdown/bitburner.userinterface.clearterminal.md b/markdown/bitburner.userinterface.clearterminal.md index d19cd448d..753a2cb39 100644 --- a/markdown/bitburner.userinterface.clearterminal.md +++ b/markdown/bitburner.userinterface.clearterminal.md @@ -6,12 +6,12 @@ Clear the Terminal window, as if the player ran `clear` in the terminal -Signature: +**Signature:** ```typescript clearTerminal(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.userinterface.getgameinfo.md b/markdown/bitburner.userinterface.getgameinfo.md index de295a735..ad5b83cba 100644 --- a/markdown/bitburner.userinterface.getgameinfo.md +++ b/markdown/bitburner.userinterface.getgameinfo.md @@ -6,12 +6,12 @@ Gets the current game information (version, commit, ...) -Signature: +**Signature:** ```typescript getGameInfo(): GameInfo; ``` -Returns: +**Returns:** [GameInfo](./bitburner.gameinfo.md) diff --git a/markdown/bitburner.userinterface.getstyles.md b/markdown/bitburner.userinterface.getstyles.md index 5699ce85b..ae358a6cd 100644 --- a/markdown/bitburner.userinterface.getstyles.md +++ b/markdown/bitburner.userinterface.getstyles.md @@ -6,12 +6,12 @@ Get the current styles -Signature: +**Signature:** ```typescript getStyles(): IStyleSettings; ``` -Returns: +**Returns:** [IStyleSettings](./bitburner.istylesettings.md) diff --git a/markdown/bitburner.userinterface.gettheme.md b/markdown/bitburner.userinterface.gettheme.md index c2bce91d2..af2dec64d 100644 --- a/markdown/bitburner.userinterface.gettheme.md +++ b/markdown/bitburner.userinterface.gettheme.md @@ -6,12 +6,12 @@ Get the current theme -Signature: +**Signature:** ```typescript getTheme(): UserInterfaceTheme; ``` -Returns: +**Returns:** [UserInterfaceTheme](./bitburner.userinterfacetheme.md) diff --git a/markdown/bitburner.userinterface.md b/markdown/bitburner.userinterface.md index 17bba0362..44c170a99 100644 --- a/markdown/bitburner.userinterface.md +++ b/markdown/bitburner.userinterface.md @@ -6,7 +6,7 @@ User Interface API. -Signature: +**Signature:** ```typescript interface UserInterface diff --git a/markdown/bitburner.userinterface.resetstyles.md b/markdown/bitburner.userinterface.resetstyles.md index e562b93ff..3b7bdb7a2 100644 --- a/markdown/bitburner.userinterface.resetstyles.md +++ b/markdown/bitburner.userinterface.resetstyles.md @@ -6,12 +6,12 @@ Resets the player's styles to the default values -Signature: +**Signature:** ```typescript resetStyles(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.userinterface.resettheme.md b/markdown/bitburner.userinterface.resettheme.md index 051b0f5a7..d50b4c3c7 100644 --- a/markdown/bitburner.userinterface.resettheme.md +++ b/markdown/bitburner.userinterface.resettheme.md @@ -6,12 +6,12 @@ Resets the player's theme to the default values -Signature: +**Signature:** ```typescript resetTheme(): void; ``` -Returns: +**Returns:** void diff --git a/markdown/bitburner.userinterface.setstyles.md b/markdown/bitburner.userinterface.setstyles.md index fef8ce290..9d166c529 100644 --- a/markdown/bitburner.userinterface.setstyles.md +++ b/markdown/bitburner.userinterface.setstyles.md @@ -6,7 +6,7 @@ Sets the current styles -Signature: +**Signature:** ```typescript setStyles(newStyles: IStyleSettings): void; @@ -18,7 +18,7 @@ setStyles(newStyles: IStyleSettings): void; | --- | --- | --- | | newStyles | [IStyleSettings](./bitburner.istylesettings.md) | | -Returns: +**Returns:** void diff --git a/markdown/bitburner.userinterface.settheme.md b/markdown/bitburner.userinterface.settheme.md index 2d36917aa..1ce3e9acb 100644 --- a/markdown/bitburner.userinterface.settheme.md +++ b/markdown/bitburner.userinterface.settheme.md @@ -6,7 +6,7 @@ Sets the current theme -Signature: +**Signature:** ```typescript setTheme(newTheme: UserInterfaceTheme): void; @@ -18,7 +18,7 @@ setTheme(newTheme: UserInterfaceTheme): void; | --- | --- | --- | | newTheme | [UserInterfaceTheme](./bitburner.userinterfacetheme.md) | | -Returns: +**Returns:** void diff --git a/markdown/bitburner.userinterface.windowsize.md b/markdown/bitburner.userinterface.windowsize.md index 3727787e9..d9b2884b8 100644 --- a/markdown/bitburner.userinterface.windowsize.md +++ b/markdown/bitburner.userinterface.windowsize.md @@ -6,12 +6,12 @@ Get the current window size -Signature: +**Signature:** ```typescript windowSize(): [number, number]; ``` -Returns: +**Returns:** \[number, number\] diff --git a/markdown/bitburner.userinterfacetheme.backgroundprimary.md b/markdown/bitburner.userinterfacetheme.backgroundprimary.md index a7b5588b6..a4edae75f 100644 --- a/markdown/bitburner.userinterfacetheme.backgroundprimary.md +++ b/markdown/bitburner.userinterfacetheme.backgroundprimary.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.backgroundprimary property -Signature: +**Signature:** ```typescript backgroundprimary: string; diff --git a/markdown/bitburner.userinterfacetheme.backgroundsecondary.md b/markdown/bitburner.userinterfacetheme.backgroundsecondary.md index 9af7a9f32..9e044b69b 100644 --- a/markdown/bitburner.userinterfacetheme.backgroundsecondary.md +++ b/markdown/bitburner.userinterfacetheme.backgroundsecondary.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.backgroundsecondary property -Signature: +**Signature:** ```typescript backgroundsecondary: string; diff --git a/markdown/bitburner.userinterfacetheme.black.md b/markdown/bitburner.userinterfacetheme.black.md index ed24158fe..8899a1b27 100644 --- a/markdown/bitburner.userinterfacetheme.black.md +++ b/markdown/bitburner.userinterfacetheme.black.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.black property -Signature: +**Signature:** ```typescript black: string; diff --git a/markdown/bitburner.userinterfacetheme.button.md b/markdown/bitburner.userinterfacetheme.button.md index c7ea13560..37a942ec2 100644 --- a/markdown/bitburner.userinterfacetheme.button.md +++ b/markdown/bitburner.userinterfacetheme.button.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.button property -Signature: +**Signature:** ```typescript button: string; diff --git a/markdown/bitburner.userinterfacetheme.cha.md b/markdown/bitburner.userinterfacetheme.cha.md index 5cd9a2259..d6d923583 100644 --- a/markdown/bitburner.userinterfacetheme.cha.md +++ b/markdown/bitburner.userinterfacetheme.cha.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.cha property -Signature: +**Signature:** ```typescript cha: string; diff --git a/markdown/bitburner.userinterfacetheme.combat.md b/markdown/bitburner.userinterfacetheme.combat.md index bb007288e..0f2c78308 100644 --- a/markdown/bitburner.userinterfacetheme.combat.md +++ b/markdown/bitburner.userinterfacetheme.combat.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.combat property -Signature: +**Signature:** ```typescript combat: string; diff --git a/markdown/bitburner.userinterfacetheme.disabled.md b/markdown/bitburner.userinterfacetheme.disabled.md index b95cd9b20..b8f265680 100644 --- a/markdown/bitburner.userinterfacetheme.disabled.md +++ b/markdown/bitburner.userinterfacetheme.disabled.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.disabled property -Signature: +**Signature:** ```typescript disabled: string; diff --git a/markdown/bitburner.userinterfacetheme.error.md b/markdown/bitburner.userinterfacetheme.error.md index c5f00a6d6..7411d6576 100644 --- a/markdown/bitburner.userinterfacetheme.error.md +++ b/markdown/bitburner.userinterfacetheme.error.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.error property -Signature: +**Signature:** ```typescript error: string; diff --git a/markdown/bitburner.userinterfacetheme.errordark.md b/markdown/bitburner.userinterfacetheme.errordark.md index c4ca9b309..16132208f 100644 --- a/markdown/bitburner.userinterfacetheme.errordark.md +++ b/markdown/bitburner.userinterfacetheme.errordark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.errordark property -Signature: +**Signature:** ```typescript errordark: string; diff --git a/markdown/bitburner.userinterfacetheme.errorlight.md b/markdown/bitburner.userinterfacetheme.errorlight.md index 23101a406..1182364b7 100644 --- a/markdown/bitburner.userinterfacetheme.errorlight.md +++ b/markdown/bitburner.userinterfacetheme.errorlight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.errorlight property -Signature: +**Signature:** ```typescript errorlight: string; diff --git a/markdown/bitburner.userinterfacetheme.hack.md b/markdown/bitburner.userinterfacetheme.hack.md index 3c850196a..812c0bf35 100644 --- a/markdown/bitburner.userinterfacetheme.hack.md +++ b/markdown/bitburner.userinterfacetheme.hack.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.hack property -Signature: +**Signature:** ```typescript hack: string; diff --git a/markdown/bitburner.userinterfacetheme.hp.md b/markdown/bitburner.userinterfacetheme.hp.md index ec04df67b..a01070df7 100644 --- a/markdown/bitburner.userinterfacetheme.hp.md +++ b/markdown/bitburner.userinterfacetheme.hp.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.hp property -Signature: +**Signature:** ```typescript hp: string; diff --git a/markdown/bitburner.userinterfacetheme.info.md b/markdown/bitburner.userinterfacetheme.info.md index 4a72fa673..aaf3599d2 100644 --- a/markdown/bitburner.userinterfacetheme.info.md +++ b/markdown/bitburner.userinterfacetheme.info.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.info property -Signature: +**Signature:** ```typescript info: string; diff --git a/markdown/bitburner.userinterfacetheme.infodark.md b/markdown/bitburner.userinterfacetheme.infodark.md index 68febe2b2..dab9cd969 100644 --- a/markdown/bitburner.userinterfacetheme.infodark.md +++ b/markdown/bitburner.userinterfacetheme.infodark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.infodark property -Signature: +**Signature:** ```typescript infodark: string; diff --git a/markdown/bitburner.userinterfacetheme.infolight.md b/markdown/bitburner.userinterfacetheme.infolight.md index f8f8afd06..bc4ee3cce 100644 --- a/markdown/bitburner.userinterfacetheme.infolight.md +++ b/markdown/bitburner.userinterfacetheme.infolight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.infolight property -Signature: +**Signature:** ```typescript infolight: string; diff --git a/markdown/bitburner.userinterfacetheme.int.md b/markdown/bitburner.userinterfacetheme.int.md index 76d89b75f..93c13ba29 100644 --- a/markdown/bitburner.userinterfacetheme.int.md +++ b/markdown/bitburner.userinterfacetheme.int.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.int property -Signature: +**Signature:** ```typescript int: string; diff --git a/markdown/bitburner.userinterfacetheme.md b/markdown/bitburner.userinterfacetheme.md index 984637705..10ba38a13 100644 --- a/markdown/bitburner.userinterfacetheme.md +++ b/markdown/bitburner.userinterfacetheme.md @@ -6,7 +6,7 @@ Interface Theme -Signature: +**Signature:** ```typescript interface UserInterfaceTheme @@ -14,39 +14,39 @@ interface UserInterfaceTheme ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) | string | | -| [backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) | string | | -| [black](./bitburner.userinterfacetheme.black.md) | string | | -| [button](./bitburner.userinterfacetheme.button.md) | string | | -| [cha](./bitburner.userinterfacetheme.cha.md) | string | | -| [combat](./bitburner.userinterfacetheme.combat.md) | string | | -| [disabled](./bitburner.userinterfacetheme.disabled.md) | string | | -| [error](./bitburner.userinterfacetheme.error.md) | string | | -| [errordark](./bitburner.userinterfacetheme.errordark.md) | string | | -| [errorlight](./bitburner.userinterfacetheme.errorlight.md) | string | | -| [hack](./bitburner.userinterfacetheme.hack.md) | string | | -| [hp](./bitburner.userinterfacetheme.hp.md) | string | | -| [info](./bitburner.userinterfacetheme.info.md) | string | | -| [infodark](./bitburner.userinterfacetheme.infodark.md) | string | | -| [infolight](./bitburner.userinterfacetheme.infolight.md) | string | | -| [int](./bitburner.userinterfacetheme.int.md) | string | | -| [money](./bitburner.userinterfacetheme.money.md) | string | | -| [primary](./bitburner.userinterfacetheme.primary.md) | string | | -| [primarydark](./bitburner.userinterfacetheme.primarydark.md) | string | | -| [primarylight](./bitburner.userinterfacetheme.primarylight.md) | string | | -| [rep](./bitburner.userinterfacetheme.rep.md) | string | | -| [secondary](./bitburner.userinterfacetheme.secondary.md) | string | | -| [secondarydark](./bitburner.userinterfacetheme.secondarydark.md) | string | | -| [secondarylight](./bitburner.userinterfacetheme.secondarylight.md) | string | | -| [success](./bitburner.userinterfacetheme.success.md) | string | | -| [successdark](./bitburner.userinterfacetheme.successdark.md) | string | | -| [successlight](./bitburner.userinterfacetheme.successlight.md) | string | | -| [warning](./bitburner.userinterfacetheme.warning.md) | string | | -| [warningdark](./bitburner.userinterfacetheme.warningdark.md) | string | | -| [warninglight](./bitburner.userinterfacetheme.warninglight.md) | string | | -| [well](./bitburner.userinterfacetheme.well.md) | string | | -| [welllight](./bitburner.userinterfacetheme.welllight.md) | string | | -| [white](./bitburner.userinterfacetheme.white.md) | string | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) | | string | | +| [backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) | | string | | +| [black](./bitburner.userinterfacetheme.black.md) | | string | | +| [button](./bitburner.userinterfacetheme.button.md) | | string | | +| [cha](./bitburner.userinterfacetheme.cha.md) | | string | | +| [combat](./bitburner.userinterfacetheme.combat.md) | | string | | +| [disabled](./bitburner.userinterfacetheme.disabled.md) | | string | | +| [error](./bitburner.userinterfacetheme.error.md) | | string | | +| [errordark](./bitburner.userinterfacetheme.errordark.md) | | string | | +| [errorlight](./bitburner.userinterfacetheme.errorlight.md) | | string | | +| [hack](./bitburner.userinterfacetheme.hack.md) | | string | | +| [hp](./bitburner.userinterfacetheme.hp.md) | | string | | +| [info](./bitburner.userinterfacetheme.info.md) | | string | | +| [infodark](./bitburner.userinterfacetheme.infodark.md) | | string | | +| [infolight](./bitburner.userinterfacetheme.infolight.md) | | string | | +| [int](./bitburner.userinterfacetheme.int.md) | | string | | +| [money](./bitburner.userinterfacetheme.money.md) | | string | | +| [primary](./bitburner.userinterfacetheme.primary.md) | | string | | +| [primarydark](./bitburner.userinterfacetheme.primarydark.md) | | string | | +| [primarylight](./bitburner.userinterfacetheme.primarylight.md) | | string | | +| [rep](./bitburner.userinterfacetheme.rep.md) | | string | | +| [secondary](./bitburner.userinterfacetheme.secondary.md) | | string | | +| [secondarydark](./bitburner.userinterfacetheme.secondarydark.md) | | string | | +| [secondarylight](./bitburner.userinterfacetheme.secondarylight.md) | | string | | +| [success](./bitburner.userinterfacetheme.success.md) | | string | | +| [successdark](./bitburner.userinterfacetheme.successdark.md) | | string | | +| [successlight](./bitburner.userinterfacetheme.successlight.md) | | string | | +| [warning](./bitburner.userinterfacetheme.warning.md) | | string | | +| [warningdark](./bitburner.userinterfacetheme.warningdark.md) | | string | | +| [warninglight](./bitburner.userinterfacetheme.warninglight.md) | | string | | +| [well](./bitburner.userinterfacetheme.well.md) | | string | | +| [welllight](./bitburner.userinterfacetheme.welllight.md) | | string | | +| [white](./bitburner.userinterfacetheme.white.md) | | string | | diff --git a/markdown/bitburner.userinterfacetheme.money.md b/markdown/bitburner.userinterfacetheme.money.md index 549d8952f..0695028eb 100644 --- a/markdown/bitburner.userinterfacetheme.money.md +++ b/markdown/bitburner.userinterfacetheme.money.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.money property -Signature: +**Signature:** ```typescript money: string; diff --git a/markdown/bitburner.userinterfacetheme.primary.md b/markdown/bitburner.userinterfacetheme.primary.md index 8767ac550..e2dd955bd 100644 --- a/markdown/bitburner.userinterfacetheme.primary.md +++ b/markdown/bitburner.userinterfacetheme.primary.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.primary property -Signature: +**Signature:** ```typescript primary: string; diff --git a/markdown/bitburner.userinterfacetheme.primarydark.md b/markdown/bitburner.userinterfacetheme.primarydark.md index 7a50626a2..bc4a4ae31 100644 --- a/markdown/bitburner.userinterfacetheme.primarydark.md +++ b/markdown/bitburner.userinterfacetheme.primarydark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.primarydark property -Signature: +**Signature:** ```typescript primarydark: string; diff --git a/markdown/bitburner.userinterfacetheme.primarylight.md b/markdown/bitburner.userinterfacetheme.primarylight.md index 8cd07cb5a..7eee77725 100644 --- a/markdown/bitburner.userinterfacetheme.primarylight.md +++ b/markdown/bitburner.userinterfacetheme.primarylight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.primarylight property -Signature: +**Signature:** ```typescript primarylight: string; diff --git a/markdown/bitburner.userinterfacetheme.rep.md b/markdown/bitburner.userinterfacetheme.rep.md index 4a6c6f955..ccc2bdadd 100644 --- a/markdown/bitburner.userinterfacetheme.rep.md +++ b/markdown/bitburner.userinterfacetheme.rep.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.rep property -Signature: +**Signature:** ```typescript rep: string; diff --git a/markdown/bitburner.userinterfacetheme.secondary.md b/markdown/bitburner.userinterfacetheme.secondary.md index 2d439e361..40da79619 100644 --- a/markdown/bitburner.userinterfacetheme.secondary.md +++ b/markdown/bitburner.userinterfacetheme.secondary.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.secondary property -Signature: +**Signature:** ```typescript secondary: string; diff --git a/markdown/bitburner.userinterfacetheme.secondarydark.md b/markdown/bitburner.userinterfacetheme.secondarydark.md index 52fa78a9f..91b53cd07 100644 --- a/markdown/bitburner.userinterfacetheme.secondarydark.md +++ b/markdown/bitburner.userinterfacetheme.secondarydark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.secondarydark property -Signature: +**Signature:** ```typescript secondarydark: string; diff --git a/markdown/bitburner.userinterfacetheme.secondarylight.md b/markdown/bitburner.userinterfacetheme.secondarylight.md index 9572e4af8..19cb9ac02 100644 --- a/markdown/bitburner.userinterfacetheme.secondarylight.md +++ b/markdown/bitburner.userinterfacetheme.secondarylight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.secondarylight property -Signature: +**Signature:** ```typescript secondarylight: string; diff --git a/markdown/bitburner.userinterfacetheme.success.md b/markdown/bitburner.userinterfacetheme.success.md index 3d26d4eeb..01e2457dd 100644 --- a/markdown/bitburner.userinterfacetheme.success.md +++ b/markdown/bitburner.userinterfacetheme.success.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.success property -Signature: +**Signature:** ```typescript success: string; diff --git a/markdown/bitburner.userinterfacetheme.successdark.md b/markdown/bitburner.userinterfacetheme.successdark.md index 48501f620..0926d11d3 100644 --- a/markdown/bitburner.userinterfacetheme.successdark.md +++ b/markdown/bitburner.userinterfacetheme.successdark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.successdark property -Signature: +**Signature:** ```typescript successdark: string; diff --git a/markdown/bitburner.userinterfacetheme.successlight.md b/markdown/bitburner.userinterfacetheme.successlight.md index c170e1c36..a685a7286 100644 --- a/markdown/bitburner.userinterfacetheme.successlight.md +++ b/markdown/bitburner.userinterfacetheme.successlight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.successlight property -Signature: +**Signature:** ```typescript successlight: string; diff --git a/markdown/bitburner.userinterfacetheme.warning.md b/markdown/bitburner.userinterfacetheme.warning.md index 40d2c7391..8498890b1 100644 --- a/markdown/bitburner.userinterfacetheme.warning.md +++ b/markdown/bitburner.userinterfacetheme.warning.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.warning property -Signature: +**Signature:** ```typescript warning: string; diff --git a/markdown/bitburner.userinterfacetheme.warningdark.md b/markdown/bitburner.userinterfacetheme.warningdark.md index 9942c4130..cfb4ee24d 100644 --- a/markdown/bitburner.userinterfacetheme.warningdark.md +++ b/markdown/bitburner.userinterfacetheme.warningdark.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.warningdark property -Signature: +**Signature:** ```typescript warningdark: string; diff --git a/markdown/bitburner.userinterfacetheme.warninglight.md b/markdown/bitburner.userinterfacetheme.warninglight.md index ac142bd06..def41d5a7 100644 --- a/markdown/bitburner.userinterfacetheme.warninglight.md +++ b/markdown/bitburner.userinterfacetheme.warninglight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.warninglight property -Signature: +**Signature:** ```typescript warninglight: string; diff --git a/markdown/bitburner.userinterfacetheme.well.md b/markdown/bitburner.userinterfacetheme.well.md index 77c4fd8a4..909b54315 100644 --- a/markdown/bitburner.userinterfacetheme.well.md +++ b/markdown/bitburner.userinterfacetheme.well.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.well property -Signature: +**Signature:** ```typescript well: string; diff --git a/markdown/bitburner.userinterfacetheme.welllight.md b/markdown/bitburner.userinterfacetheme.welllight.md index 3b05a82b1..3e09c41f6 100644 --- a/markdown/bitburner.userinterfacetheme.welllight.md +++ b/markdown/bitburner.userinterfacetheme.welllight.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.welllight property -Signature: +**Signature:** ```typescript welllight: string; diff --git a/markdown/bitburner.userinterfacetheme.white.md b/markdown/bitburner.userinterfacetheme.white.md index ef7690856..1ee4d276e 100644 --- a/markdown/bitburner.userinterfacetheme.white.md +++ b/markdown/bitburner.userinterfacetheme.white.md @@ -4,7 +4,7 @@ ## UserInterfaceTheme.white property -Signature: +**Signature:** ```typescript white: string; diff --git a/markdown/bitburner.warehouse.level.md b/markdown/bitburner.warehouse.level.md index 6731abb55..f6e7e1e68 100644 --- a/markdown/bitburner.warehouse.level.md +++ b/markdown/bitburner.warehouse.level.md @@ -6,7 +6,7 @@ Amount of size upgrade bought -Signature: +**Signature:** ```typescript level: number; diff --git a/markdown/bitburner.warehouse.loc.md b/markdown/bitburner.warehouse.loc.md index 28d61e1c5..ebe775ab8 100644 --- a/markdown/bitburner.warehouse.loc.md +++ b/markdown/bitburner.warehouse.loc.md @@ -6,7 +6,7 @@ City in which the warehouse is located -Signature: +**Signature:** ```typescript loc: CityName; diff --git a/markdown/bitburner.warehouse.md b/markdown/bitburner.warehouse.md index 5b46fc8f7..21c56a306 100644 --- a/markdown/bitburner.warehouse.md +++ b/markdown/bitburner.warehouse.md @@ -6,7 +6,7 @@ Warehouse for a division in a city -Signature: +**Signature:** ```typescript interface Warehouse @@ -14,11 +14,11 @@ interface Warehouse ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [level](./bitburner.warehouse.level.md) | number | Amount of size upgrade bought | -| [loc](./bitburner.warehouse.loc.md) | [CityName](./bitburner.cityname.md) | City in which the warehouse is located | -| [size](./bitburner.warehouse.size.md) | number | Total space in the warehouse | -| [sizeUsed](./bitburner.warehouse.sizeused.md) | number | Used space in the warehouse | -| [smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md) | boolean | Smart Supply status in the warehouse | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [level](./bitburner.warehouse.level.md) | | number | Amount of size upgrade bought | +| [loc](./bitburner.warehouse.loc.md) | | [CityName](./bitburner.cityname.md) | City in which the warehouse is located | +| [size](./bitburner.warehouse.size.md) | | number | Total space in the warehouse | +| [sizeUsed](./bitburner.warehouse.sizeused.md) | | number | Used space in the warehouse | +| [smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md) | | boolean | Smart Supply status in the warehouse | diff --git a/markdown/bitburner.warehouse.size.md b/markdown/bitburner.warehouse.size.md index c9c22962b..a5f9460ad 100644 --- a/markdown/bitburner.warehouse.size.md +++ b/markdown/bitburner.warehouse.size.md @@ -6,7 +6,7 @@ Total space in the warehouse -Signature: +**Signature:** ```typescript size: number; diff --git a/markdown/bitburner.warehouse.sizeused.md b/markdown/bitburner.warehouse.sizeused.md index 7a540be52..df2e1c342 100644 --- a/markdown/bitburner.warehouse.sizeused.md +++ b/markdown/bitburner.warehouse.sizeused.md @@ -6,7 +6,7 @@ Used space in the warehouse -Signature: +**Signature:** ```typescript sizeUsed: number; diff --git a/markdown/bitburner.warehouse.smartsupplyenabled.md b/markdown/bitburner.warehouse.smartsupplyenabled.md index e95f75388..8a0f450b5 100644 --- a/markdown/bitburner.warehouse.smartsupplyenabled.md +++ b/markdown/bitburner.warehouse.smartsupplyenabled.md @@ -6,7 +6,7 @@ Smart Supply status in the warehouse -Signature: +**Signature:** ```typescript smartSupplyEnabled: boolean; diff --git a/markdown/bitburner.warehouseapi.bulkpurchase.md b/markdown/bitburner.warehouseapi.bulkpurchase.md index 861e41285..ce7b37f87 100644 --- a/markdown/bitburner.warehouseapi.bulkpurchase.md +++ b/markdown/bitburner.warehouseapi.bulkpurchase.md @@ -6,7 +6,7 @@ Set material to bulk buy -Signature: +**Signature:** ```typescript bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; @@ -21,7 +21,7 @@ bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: | materialName | string | Name of the material | | amt | number | Amount of material to buy | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.buymaterial.md b/markdown/bitburner.warehouseapi.buymaterial.md index 4dd91bafa..7aa1e0c53 100644 --- a/markdown/bitburner.warehouseapi.buymaterial.md +++ b/markdown/bitburner.warehouseapi.buymaterial.md @@ -6,7 +6,7 @@ Set material buy data -Signature: +**Signature:** ```typescript buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; @@ -21,7 +21,7 @@ buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: | materialName | string | Name of the material | | amt | number | Amount of material to buy | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.cancelexportmaterial.md b/markdown/bitburner.warehouseapi.cancelexportmaterial.md index bbc0c9709..d55022857 100644 --- a/markdown/bitburner.warehouseapi.cancelexportmaterial.md +++ b/markdown/bitburner.warehouseapi.cancelexportmaterial.md @@ -6,7 +6,7 @@ Cancel material export -Signature: +**Signature:** ```typescript cancelExportMaterial( @@ -30,7 +30,7 @@ cancelExportMaterial( | materialName | string | Name of the material | | amt | number | Amount of material to export. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.discontinueproduct.md b/markdown/bitburner.warehouseapi.discontinueproduct.md index 86c1689cb..ae88a1d84 100644 --- a/markdown/bitburner.warehouseapi.discontinueproduct.md +++ b/markdown/bitburner.warehouseapi.discontinueproduct.md @@ -6,7 +6,7 @@ Discontinue a product. -Signature: +**Signature:** ```typescript discontinueProduct(divisionName: string, productName: string): void; @@ -19,7 +19,7 @@ discontinueProduct(divisionName: string, productName: string): void; | divisionName | string | Name of the division | | productName | string | Name of the product | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.exportmaterial.md b/markdown/bitburner.warehouseapi.exportmaterial.md index 4c7cfef4f..81f32e89f 100644 --- a/markdown/bitburner.warehouseapi.exportmaterial.md +++ b/markdown/bitburner.warehouseapi.exportmaterial.md @@ -6,7 +6,7 @@ Set material export data -Signature: +**Signature:** ```typescript exportMaterial( @@ -30,7 +30,7 @@ exportMaterial( | materialName | string | Name of the material | | amt | number | Amount of material to export. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.getmaterial.md b/markdown/bitburner.warehouseapi.getmaterial.md index 523fc64ef..99b09cd76 100644 --- a/markdown/bitburner.warehouseapi.getmaterial.md +++ b/markdown/bitburner.warehouseapi.getmaterial.md @@ -6,7 +6,7 @@ Get material data -Signature: +**Signature:** ```typescript getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string): Material; @@ -20,7 +20,7 @@ getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | materialName | string | Name of the material | -Returns: +**Returns:** [Material](./bitburner.material.md) diff --git a/markdown/bitburner.warehouseapi.getproduct.md b/markdown/bitburner.warehouseapi.getproduct.md index fbbd68d69..1c07f887d 100644 --- a/markdown/bitburner.warehouseapi.getproduct.md +++ b/markdown/bitburner.warehouseapi.getproduct.md @@ -6,7 +6,7 @@ Get product data -Signature: +**Signature:** ```typescript getProduct(divisionName: string, productName: string): Product; @@ -19,7 +19,7 @@ getProduct(divisionName: string, productName: string): Product; | divisionName | string | Name of the division | | productName | string | Name of the product | -Returns: +**Returns:** [Product](./bitburner.product.md) diff --git a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md index a5e3e6d6a..37b8199ea 100644 --- a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md +++ b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md @@ -6,7 +6,7 @@ Gets the cost to upgrade a warehouse to the next level -Signature: +**Signature:** ```typescript getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, amt?: number): number; @@ -18,9 +18,9 @@ getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, am | --- | --- | --- | | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -| amt | number | amount of upgrades. Optional, defaults to 1 | +| amt | number | _(Optional)_ amount of upgrades. Optional, defaults to 1 | -Returns: +**Returns:** number diff --git a/markdown/bitburner.warehouseapi.getwarehouse.md b/markdown/bitburner.warehouseapi.getwarehouse.md index 336582981..ecac92576 100644 --- a/markdown/bitburner.warehouseapi.getwarehouse.md +++ b/markdown/bitburner.warehouseapi.getwarehouse.md @@ -6,7 +6,7 @@ Get warehouse data -Signature: +**Signature:** ```typescript getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; @@ -19,7 +19,7 @@ getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -Returns: +**Returns:** [Warehouse](./bitburner.warehouse.md) diff --git a/markdown/bitburner.warehouseapi.haswarehouse.md b/markdown/bitburner.warehouseapi.haswarehouse.md index c8d6a16ec..58f3359f8 100644 --- a/markdown/bitburner.warehouseapi.haswarehouse.md +++ b/markdown/bitburner.warehouseapi.haswarehouse.md @@ -6,7 +6,7 @@ Check if you have a warehouse in city -Signature: +**Signature:** ```typescript hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; @@ -19,7 +19,7 @@ hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; | divisionName | string | | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | | -Returns: +**Returns:** boolean diff --git a/markdown/bitburner.warehouseapi.limitmaterialproduction.md b/markdown/bitburner.warehouseapi.limitmaterialproduction.md index 93233e565..80974f21f 100644 --- a/markdown/bitburner.warehouseapi.limitmaterialproduction.md +++ b/markdown/bitburner.warehouseapi.limitmaterialproduction.md @@ -6,7 +6,7 @@ Limit Material Production. -Signature: +**Signature:** ```typescript limitMaterialProduction( @@ -26,7 +26,7 @@ limitMaterialProduction( | materialName | string | Name of the material. | | qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.limitproductproduction.md b/markdown/bitburner.warehouseapi.limitproductproduction.md index f83fdf313..0f13d6554 100644 --- a/markdown/bitburner.warehouseapi.limitproductproduction.md +++ b/markdown/bitburner.warehouseapi.limitproductproduction.md @@ -6,7 +6,7 @@ Limit Product Production. -Signature: +**Signature:** ```typescript limitProductProduction(divisionName: string, city: CityName | `${CityName}`, productName: string, qty: number): void; @@ -21,7 +21,7 @@ limitProductProduction(divisionName: string, city: CityName | `${CityName}`, pro | productName | string | Name of the product. | | qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.makeproduct.md b/markdown/bitburner.warehouseapi.makeproduct.md index e35e1bade..f0a08cd1d 100644 --- a/markdown/bitburner.warehouseapi.makeproduct.md +++ b/markdown/bitburner.warehouseapi.makeproduct.md @@ -6,7 +6,7 @@ Create a new product -Signature: +**Signature:** ```typescript makeProduct( @@ -28,7 +28,7 @@ makeProduct( | designInvest | number | Amount to invest for the design of the product. | | marketingInvest | number | Amount to invest for the marketing of the product. | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.md b/markdown/bitburner.warehouseapi.md index b19d41d7d..0fa653b03 100644 --- a/markdown/bitburner.warehouseapi.md +++ b/markdown/bitburner.warehouseapi.md @@ -6,7 +6,7 @@ Corporation Warehouse API -Signature: +**Signature:** ```typescript export interface WarehouseAPI diff --git a/markdown/bitburner.warehouseapi.purchasewarehouse.md b/markdown/bitburner.warehouseapi.purchasewarehouse.md index 9cc7742f3..04b8f2f2b 100644 --- a/markdown/bitburner.warehouseapi.purchasewarehouse.md +++ b/markdown/bitburner.warehouseapi.purchasewarehouse.md @@ -6,7 +6,7 @@ Purchase warehouse for a new city -Signature: +**Signature:** ```typescript purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; @@ -19,7 +19,7 @@ purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.sellmaterial.md b/markdown/bitburner.warehouseapi.sellmaterial.md index 78758479a..4f7d839c8 100644 --- a/markdown/bitburner.warehouseapi.sellmaterial.md +++ b/markdown/bitburner.warehouseapi.sellmaterial.md @@ -6,7 +6,7 @@ Set material sell data. -Signature: +**Signature:** ```typescript sellMaterial( @@ -28,7 +28,7 @@ sellMaterial( | amt | string | Amount to sell, can be "MAX" | | price | string | Price to sell, can be "MP" | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.sellproduct.md b/markdown/bitburner.warehouseapi.sellproduct.md index eed38f42f..280997e9e 100644 --- a/markdown/bitburner.warehouseapi.sellproduct.md +++ b/markdown/bitburner.warehouseapi.sellproduct.md @@ -6,7 +6,7 @@ Set product sell data. -Signature: +**Signature:** ```typescript sellProduct( @@ -30,7 +30,7 @@ sellProduct( | price | string | Price to sell, can be "MP" | | all | boolean | Sell in all city | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md index 3d0d158a7..d7d9c3467 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md @@ -6,7 +6,7 @@ Set market TA 1 for a material. -Signature: +**Signature:** ```typescript setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; @@ -21,7 +21,7 @@ setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, mater | materialName | string | Name of the material | | on | boolean | market ta enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md index 3c9546691..84aa7e57e 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md @@ -6,7 +6,7 @@ Set market TA 2 for a material. -Signature: +**Signature:** ```typescript setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; @@ -21,7 +21,7 @@ setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, mater | materialName | string | Name of the material | | on | boolean | market ta enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setproductmarketta1.md b/markdown/bitburner.warehouseapi.setproductmarketta1.md index 79be65bf2..161f9118a 100644 --- a/markdown/bitburner.warehouseapi.setproductmarketta1.md +++ b/markdown/bitburner.warehouseapi.setproductmarketta1.md @@ -6,7 +6,7 @@ Set market TA 1 for a product. -Signature: +**Signature:** ```typescript setProductMarketTA1(divisionName: string, productName: string, on: boolean): void; @@ -20,7 +20,7 @@ setProductMarketTA1(divisionName: string, productName: string, on: boolean): voi | productName | string | Name of the product | | on | boolean | market ta enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setproductmarketta2.md b/markdown/bitburner.warehouseapi.setproductmarketta2.md index c278671c0..d2c7c07ea 100644 --- a/markdown/bitburner.warehouseapi.setproductmarketta2.md +++ b/markdown/bitburner.warehouseapi.setproductmarketta2.md @@ -6,7 +6,7 @@ Set market TA 2 for a product. -Signature: +**Signature:** ```typescript setProductMarketTA2(divisionName: string, productName: string, on: boolean): void; @@ -20,7 +20,7 @@ setProductMarketTA2(divisionName: string, productName: string, on: boolean): voi | productName | string | Name of the product | | on | boolean | market ta enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setsmartsupply.md b/markdown/bitburner.warehouseapi.setsmartsupply.md index 6daa5d4ca..5125e1fbe 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupply.md +++ b/markdown/bitburner.warehouseapi.setsmartsupply.md @@ -6,7 +6,7 @@ Set smart supply -Signature: +**Signature:** ```typescript setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: boolean): void; @@ -20,7 +20,7 @@ setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: bo | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | enabled | boolean | smart supply enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md index 60efe8471..b4889cc45 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md +++ b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md @@ -6,7 +6,7 @@ Set whether smart supply uses leftovers before buying -Signature: +**Signature:** ```typescript setSmartSupplyUseLeftovers( @@ -26,7 +26,7 @@ setSmartSupplyUseLeftovers( | materialName | string | Name of the material | | enabled | boolean | smart supply use leftovers enabled | -Returns: +**Returns:** void diff --git a/markdown/bitburner.warehouseapi.upgradewarehouse.md b/markdown/bitburner.warehouseapi.upgradewarehouse.md index 7f867bbbb..fafc0de58 100644 --- a/markdown/bitburner.warehouseapi.upgradewarehouse.md +++ b/markdown/bitburner.warehouseapi.upgradewarehouse.md @@ -6,7 +6,7 @@ Upgrade warehouse -Signature: +**Signature:** ```typescript upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: number): void; @@ -18,9 +18,9 @@ upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: num | --- | --- | --- | | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | -| amt | number | amount of upgrades defaults to 1 | +| amt | number | _(Optional)_ amount of upgrades defaults to 1 | -Returns: +**Returns:** void diff --git a/markdown/bitburner.workformulas.companygains.md b/markdown/bitburner.workformulas.companygains.md index 6ea7f8cf4..c05dd06d7 100644 --- a/markdown/bitburner.workformulas.companygains.md +++ b/markdown/bitburner.workformulas.companygains.md @@ -4,7 +4,7 @@ ## WorkFormulas.companyGains() method -Signature: +**Signature:** ```typescript companyGains(person: Person, companyName: string, workType: JobName | `${JobName}`, favor: number): WorkStats; @@ -19,7 +19,7 @@ companyGains(person: Person, companyName: string, workType: JobName | `${JobName | workType | [JobName](./bitburner.jobname.md) \| \`${[JobName](./bitburner.jobname.md)}\` | | | favor | number | | -Returns: +**Returns:** [WorkStats](./bitburner.workstats.md) diff --git a/markdown/bitburner.workformulas.crimegains.md b/markdown/bitburner.workformulas.crimegains.md index 79791cd14..a4e04273f 100644 --- a/markdown/bitburner.workformulas.crimegains.md +++ b/markdown/bitburner.workformulas.crimegains.md @@ -4,7 +4,7 @@ ## WorkFormulas.crimeGains() method -Signature: +**Signature:** ```typescript crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; @@ -17,7 +17,7 @@ crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; | person | [Person](./bitburner.person.md) | | | crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | | -Returns: +**Returns:** [WorkStats](./bitburner.workstats.md) diff --git a/markdown/bitburner.workformulas.crimesuccesschance.md b/markdown/bitburner.workformulas.crimesuccesschance.md index b8beb1869..26fb441ed 100644 --- a/markdown/bitburner.workformulas.crimesuccesschance.md +++ b/markdown/bitburner.workformulas.crimesuccesschance.md @@ -4,7 +4,7 @@ ## WorkFormulas.crimeSuccessChance() method -Signature: +**Signature:** ```typescript crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number; @@ -17,7 +17,7 @@ crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): numbe | person | [Person](./bitburner.person.md) | | | crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | | -Returns: +**Returns:** number diff --git a/markdown/bitburner.workformulas.factiongains.md b/markdown/bitburner.workformulas.factiongains.md index 313d72a1d..100b15084 100644 --- a/markdown/bitburner.workformulas.factiongains.md +++ b/markdown/bitburner.workformulas.factiongains.md @@ -4,7 +4,7 @@ ## WorkFormulas.factionGains() method -Signature: +**Signature:** ```typescript factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats; @@ -18,7 +18,7 @@ factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, f | workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | | | favor | number | | -Returns: +**Returns:** [WorkStats](./bitburner.workstats.md) diff --git a/markdown/bitburner.workformulas.gymgains.md b/markdown/bitburner.workformulas.gymgains.md index 690688ce5..5bd0062e2 100644 --- a/markdown/bitburner.workformulas.gymgains.md +++ b/markdown/bitburner.workformulas.gymgains.md @@ -4,7 +4,7 @@ ## WorkFormulas.gymGains() method -Signature: +**Signature:** ```typescript gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: string): WorkStats; @@ -18,7 +18,7 @@ gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: string): | gymType | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)}\` | | | locationName | string | | -Returns: +**Returns:** [WorkStats](./bitburner.workstats.md) diff --git a/markdown/bitburner.workformulas.md b/markdown/bitburner.workformulas.md index 11c4557ec..9cc73a3aa 100644 --- a/markdown/bitburner.workformulas.md +++ b/markdown/bitburner.workformulas.md @@ -6,7 +6,7 @@ Work formulas -Signature: +**Signature:** ```typescript interface WorkFormulas diff --git a/markdown/bitburner.workformulas.universitygains.md b/markdown/bitburner.workformulas.universitygains.md index bb2cbebfd..444a90865 100644 --- a/markdown/bitburner.workformulas.universitygains.md +++ b/markdown/bitburner.workformulas.universitygains.md @@ -4,7 +4,7 @@ ## WorkFormulas.universityGains() method -Signature: +**Signature:** ```typescript universityGains( @@ -22,7 +22,7 @@ universityGains( | classType | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)}\` | | | locationName | string | | -Returns: +**Returns:** [WorkStats](./bitburner.workstats.md) diff --git a/markdown/bitburner.workstats.agiexp.md b/markdown/bitburner.workstats.agiexp.md index ba80aa014..aa2355fbb 100644 --- a/markdown/bitburner.workstats.agiexp.md +++ b/markdown/bitburner.workstats.agiexp.md @@ -4,7 +4,7 @@ ## WorkStats.agiExp property -Signature: +**Signature:** ```typescript agiExp: number; diff --git a/markdown/bitburner.workstats.chaexp.md b/markdown/bitburner.workstats.chaexp.md index 4c5a069c0..deecdd7ca 100644 --- a/markdown/bitburner.workstats.chaexp.md +++ b/markdown/bitburner.workstats.chaexp.md @@ -4,7 +4,7 @@ ## WorkStats.chaExp property -Signature: +**Signature:** ```typescript chaExp: number; diff --git a/markdown/bitburner.workstats.defexp.md b/markdown/bitburner.workstats.defexp.md index 7f59581f7..cb0664d3d 100644 --- a/markdown/bitburner.workstats.defexp.md +++ b/markdown/bitburner.workstats.defexp.md @@ -4,7 +4,7 @@ ## WorkStats.defExp property -Signature: +**Signature:** ```typescript defExp: number; diff --git a/markdown/bitburner.workstats.dexexp.md b/markdown/bitburner.workstats.dexexp.md index 13e6a05e5..41e813058 100644 --- a/markdown/bitburner.workstats.dexexp.md +++ b/markdown/bitburner.workstats.dexexp.md @@ -4,7 +4,7 @@ ## WorkStats.dexExp property -Signature: +**Signature:** ```typescript dexExp: number; diff --git a/markdown/bitburner.workstats.hackexp.md b/markdown/bitburner.workstats.hackexp.md index 90be2da13..69dc82627 100644 --- a/markdown/bitburner.workstats.hackexp.md +++ b/markdown/bitburner.workstats.hackexp.md @@ -4,7 +4,7 @@ ## WorkStats.hackExp property -Signature: +**Signature:** ```typescript hackExp: number; diff --git a/markdown/bitburner.workstats.intexp.md b/markdown/bitburner.workstats.intexp.md index 75cdd9827..27c3a98e7 100644 --- a/markdown/bitburner.workstats.intexp.md +++ b/markdown/bitburner.workstats.intexp.md @@ -4,7 +4,7 @@ ## WorkStats.intExp property -Signature: +**Signature:** ```typescript intExp: number; diff --git a/markdown/bitburner.workstats.md b/markdown/bitburner.workstats.md index 7e4156546..1f8e7ac52 100644 --- a/markdown/bitburner.workstats.md +++ b/markdown/bitburner.workstats.md @@ -5,7 +5,7 @@ ## WorkStats interface -Signature: +**Signature:** ```typescript interface WorkStats @@ -13,15 +13,15 @@ interface WorkStats ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [agiExp](./bitburner.workstats.agiexp.md) | number | | -| [chaExp](./bitburner.workstats.chaexp.md) | number | | -| [defExp](./bitburner.workstats.defexp.md) | number | | -| [dexExp](./bitburner.workstats.dexexp.md) | number | | -| [hackExp](./bitburner.workstats.hackexp.md) | number | | -| [intExp](./bitburner.workstats.intexp.md) | number | | -| [money](./bitburner.workstats.money.md) | number | | -| [reputation](./bitburner.workstats.reputation.md) | number | | -| [strExp](./bitburner.workstats.strexp.md) | number | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [agiExp](./bitburner.workstats.agiexp.md) | | number | | +| [chaExp](./bitburner.workstats.chaexp.md) | | number | | +| [defExp](./bitburner.workstats.defexp.md) | | number | | +| [dexExp](./bitburner.workstats.dexexp.md) | | number | | +| [hackExp](./bitburner.workstats.hackexp.md) | | number | | +| [intExp](./bitburner.workstats.intexp.md) | | number | | +| [money](./bitburner.workstats.money.md) | | number | | +| [reputation](./bitburner.workstats.reputation.md) | | number | | +| [strExp](./bitburner.workstats.strexp.md) | | number | | diff --git a/markdown/bitburner.workstats.money.md b/markdown/bitburner.workstats.money.md index 8e3a44b42..b16278e87 100644 --- a/markdown/bitburner.workstats.money.md +++ b/markdown/bitburner.workstats.money.md @@ -4,7 +4,7 @@ ## WorkStats.money property -Signature: +**Signature:** ```typescript money: number; diff --git a/markdown/bitburner.workstats.reputation.md b/markdown/bitburner.workstats.reputation.md index a39fb3ea9..932137601 100644 --- a/markdown/bitburner.workstats.reputation.md +++ b/markdown/bitburner.workstats.reputation.md @@ -4,7 +4,7 @@ ## WorkStats.reputation property -Signature: +**Signature:** ```typescript reputation: number; diff --git a/markdown/bitburner.workstats.strexp.md b/markdown/bitburner.workstats.strexp.md index de3254e40..f99980f72 100644 --- a/markdown/bitburner.workstats.strexp.md +++ b/markdown/bitburner.workstats.strexp.md @@ -4,7 +4,7 @@ ## WorkStats.strExp property -Signature: +**Signature:** ```typescript strExp: number; diff --git a/package-lock.json b/package-lock.json index 8319f4cf1..8f9f27913 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35,7 +35,7 @@ "material-ui-popup-state": "^1.5.3", "monaco-editor": "^0.34.1", "notistack": "^2.0.8", - "numeral": "2.0.6", + "numeral": "^2.0.6", "prop-types": "^15.8.1", "react": "^17.0.2", "react-beautiful-dnd": "^13.1.1", @@ -49,8 +49,8 @@ "@babel/preset-env": "^7.20.2", "@babel/preset-react": "^7.18.6", "@babel/preset-typescript": "^7.18.6", - "@microsoft/api-documenter": "^7.13.65", - "@microsoft/api-extractor": "^7.18.17", + "@microsoft/api-documenter": "^7.21.3", + "@microsoft/api-extractor": "^7.34.2", "@pmmmwh/react-refresh-webpack-plugin": "^0.5.10", "@types/bcryptjs": "^2.4.2", "@types/escodegen": "^0.0.7", @@ -3291,14 +3291,14 @@ } }, "node_modules/@microsoft/api-documenter": { - "version": "7.19.27", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.19.27.tgz", - "integrity": "sha512-KKNUnDlhRx+tYZsDt3Bn8OqdpCS8V9pce+ZvCjkL+nGHN4G2w1lqAtm82VdzGYgG8HgrwqZ72/Z2bsxKvPho7g==", + "version": "7.21.3", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.21.3.tgz", + "integrity": "sha512-kkuuork6xGeqDR3IIgnzmYDBgj0KLd5i7H7OehtlZ0LlXeu8i5zl26gSc+UesLaJ+M2vGH9QAvcIAf+hdPSFDw==", "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.26.2", "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.53.3", + "@rushstack/node-core-library": "3.55.0", "@rushstack/ts-command-line": "4.13.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", @@ -3308,6 +3308,51 @@ "api-documenter": "bin/api-documenter" } }, + "node_modules/@microsoft/api-documenter/node_modules/@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", + "dev": true, + "dependencies": { + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" + }, + "peerDependencies": { + "@types/node": "^14.18.36" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@microsoft/api-documenter/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==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, "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", @@ -3321,38 +3366,54 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@microsoft/api-documenter/node_modules/resolve": { - "version": "1.22.1", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", - "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", + "node_modules/@microsoft/api-documenter/node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/semver": { + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", "dev": true, "dependencies": { - "is-core-module": "^2.9.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" + "lru-cache": "^6.0.0" }, "bin": { - "resolve": "bin/resolve" + "semver": "bin/semver.js" }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "engines": { + "node": ">=10" + } + }, + "node_modules/@microsoft/api-documenter/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==", + "dev": true, + "engines": { + "node": ">= 4.0.0" } }, "node_modules/@microsoft/api-extractor": { - "version": "7.33.7", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.33.7.tgz", - "integrity": "sha512-fQT2v/j/55DhvMFiopLtth66E7xTFNhnumMKgKY14SaG6qU/V1W0e4nOAgbA+SmLakQjAd1Evu06ofaVaxBPbA==", + "version": "7.34.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.34.2.tgz", + "integrity": "sha512-oREyUU7p3JgjrqapJxEHe83gA1SXOWgaA4XCiY9PvsiLkgGHtn2ibTRgw9GCI/4kZzcb+OQv5waUDxsnQSKfwQ==", "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.26.2", "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3", + "@rushstack/node-core-library": "3.55.0", "@rushstack/rig-package": "0.3.17", "@rushstack/ts-command-line": "4.13.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", + "resolve": "~1.22.1", "semver": "~7.3.0", "source-map": "~0.6.1", "typescript": "~4.8.4" @@ -3362,32 +3423,152 @@ } }, "node_modules/@microsoft/api-extractor-model": { - "version": "7.25.3", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.25.3.tgz", - "integrity": "sha512-WWxBUq77p2iZ+5VF7Nmrm3y/UtqCh5bYV8ii3khwq3w99+fXWpvfsAhgSLsC7k8XDQc6De4ssMxH6He/qe1pzg==", + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.26.2.tgz", + "integrity": "sha512-V9tTHbYTNelTrNDXBzeDlszq29nQcjJdP6s27QJiATbqSRjEbKTeztlSVsCRHL2Wkkv5IN5jT4xkYjnFFPbK0A==", "dev": true, "dependencies": { "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3" + "@rushstack/node-core-library": "3.55.0" } }, - "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==", + "node_modules/@microsoft/api-extractor-model/node_modules/@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", "dev": true, "dependencies": { - "path-parse": "^1.0.6" + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "peerDependencies": { + "@types/node": "^14.18.36" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@microsoft/api-extractor-model/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==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/semver": { + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@microsoft/api-extractor-model/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==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", + "dev": true, + "dependencies": { + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" + }, + "peerDependencies": { + "@types/node": "^14.18.36" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@microsoft/api-extractor/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==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" } }, "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==", + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", "dev": true, "dependencies": { "lru-cache": "^6.0.0" @@ -3421,6 +3602,15 @@ "node": ">=4.2.0" } }, + "node_modules/@microsoft/api-extractor/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==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, "node_modules/@microsoft/tsdoc": { "version": "0.14.2", "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", @@ -3872,87 +4062,6 @@ "url": "https://opencollective.com/popperjs" } }, - "node_modules/@rushstack/node-core-library": { - "version": "3.53.3", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.53.3.tgz", - "integrity": "sha512-H0+T5koi5MFhJUd5ND3dI3bwLhvlABetARl78L3lWftJVQEPyzcgTStvTTRiIM5mCltyTM8VYm6BuCtNUuxD0Q==", - "dev": true, - "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", - "z-schema": "~5.0.2" - } - }, - "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==", - "dev": true - }, - "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==", - "dev": true, - "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": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", - "dev": true, - "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==", - "dev": true, - "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.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", - "dev": true, - "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==", - "dev": true, - "engines": { - "node": ">= 4.0.0" - } - }, "node_modules/@rushstack/rig-package": { "version": "0.3.17", "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.17.tgz", @@ -8992,9 +9101,9 @@ } }, "node_modules/http-cache-semantics": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz", - "integrity": "sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", "dev": true }, "node_modules/http-deceiver": { @@ -12602,7 +12711,7 @@ "node_modules/numeral": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/numeral/-/numeral-2.0.6.tgz", - "integrity": "sha1-StCAk21EPCVhrtnyGX7//iX05QY=", + "integrity": "sha512-qaKRmtYPZ5qdw4jWJD6bxEf1FJEqllJrwxCLIm0sQU/A7v2/czigzOb+C2uSiFsa9lBUzeH7M1oK+Q+OLxL3kA==", "engines": { "node": "*" } @@ -13805,12 +13914,16 @@ "dev": true }, "node_modules/resolve": { - "version": "1.20.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", - "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", + "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", "dependencies": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" + "is-core-module": "^2.9.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -14765,7 +14878,6 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "dev": true, "engines": { "node": ">= 0.4" }, @@ -18222,20 +18334,54 @@ "requires": {} }, "@microsoft/api-documenter": { - "version": "7.19.27", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.19.27.tgz", - "integrity": "sha512-KKNUnDlhRx+tYZsDt3Bn8OqdpCS8V9pce+ZvCjkL+nGHN4G2w1lqAtm82VdzGYgG8HgrwqZ72/Z2bsxKvPho7g==", + "version": "7.21.3", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.21.3.tgz", + "integrity": "sha512-kkuuork6xGeqDR3IIgnzmYDBgj0KLd5i7H7OehtlZ0LlXeu8i5zl26gSc+UesLaJ+M2vGH9QAvcIAf+hdPSFDw==", "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.26.2", "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.53.3", + "@rushstack/node-core-library": "3.55.0", "@rushstack/ts-command-line": "4.13.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", "resolve": "~1.22.1" }, "dependencies": { + "@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", + "dev": true, + "requires": { + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, "js-yaml": { "version": "3.13.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", @@ -18246,52 +18392,99 @@ "esprima": "^4.0.0" } }, - "resolve": { - "version": "1.22.1", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", - "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", "dev": true, "requires": { - "is-core-module": "^2.9.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" + "graceful-fs": "^4.1.6" } + }, + "semver": { + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "dev": true, + "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==", + "dev": true } } }, "@microsoft/api-extractor": { - "version": "7.33.7", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.33.7.tgz", - "integrity": "sha512-fQT2v/j/55DhvMFiopLtth66E7xTFNhnumMKgKY14SaG6qU/V1W0e4nOAgbA+SmLakQjAd1Evu06ofaVaxBPbA==", + "version": "7.34.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.34.2.tgz", + "integrity": "sha512-oREyUU7p3JgjrqapJxEHe83gA1SXOWgaA4XCiY9PvsiLkgGHtn2ibTRgw9GCI/4kZzcb+OQv5waUDxsnQSKfwQ==", "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.26.2", "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3", + "@rushstack/node-core-library": "3.55.0", "@rushstack/rig-package": "0.3.17", "@rushstack/ts-command-line": "4.13.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", + "resolve": "~1.22.1", "semver": "~7.3.0", "source-map": "~0.6.1", "typescript": "~4.8.4" }, "dependencies": { - "resolve": { - "version": "1.17.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", "dev": true, "requires": { - "path-parse": "^1.0.6" + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "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": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" } }, "semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", "dev": true, "requires": { "lru-cache": "^6.0.0" @@ -18308,18 +18501,84 @@ "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", "dev": true + }, + "universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true } } }, "@microsoft/api-extractor-model": { - "version": "7.25.3", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.25.3.tgz", - "integrity": "sha512-WWxBUq77p2iZ+5VF7Nmrm3y/UtqCh5bYV8ii3khwq3w99+fXWpvfsAhgSLsC7k8XDQc6De4ssMxH6He/qe1pzg==", + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.26.2.tgz", + "integrity": "sha512-V9tTHbYTNelTrNDXBzeDlszq29nQcjJdP6s27QJiATbqSRjEbKTeztlSVsCRHL2Wkkv5IN5jT4xkYjnFFPbK0A==", "dev": true, "requires": { "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3" + "@rushstack/node-core-library": "3.55.0" + }, + "dependencies": { + "@rushstack/node-core-library": { + "version": "3.55.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.55.0.tgz", + "integrity": "sha512-6lSel8w3DeGaD/JCKw64wfezEBijlCQlMwBoYg9Ci5VPy+dZ+FpBkIBrY8mi3Ge4xNzr4gyTbQ5XEt0QP1Kv/w==", + "dev": true, + "requires": { + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "14.18.36", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.36.tgz", + "integrity": "sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ==", + "dev": true, + "optional": true, + "peer": true + }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "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": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, + "semver": { + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "dev": true, + "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==", + "dev": true + } } }, "@microsoft/tsdoc": { @@ -18570,74 +18829,6 @@ "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.6.tgz", "integrity": "sha512-50/17A98tWUfQ176raKiOGXuYpLyyVMkxxG6oylzL3BPOlA6ADGdK7EYunSa4I064xerltq9TGXs8HmOk5E+vw==" }, - "@rushstack/node-core-library": { - "version": "3.53.3", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.53.3.tgz", - "integrity": "sha512-H0+T5koi5MFhJUd5ND3dI3bwLhvlABetARl78L3lWftJVQEPyzcgTStvTTRiIM5mCltyTM8VYm6BuCtNUuxD0Q==", - "dev": true, - "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", - "z-schema": "~5.0.2" - }, - "dependencies": { - "@types/node": { - "version": "12.20.24", - "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", - "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", - "dev": true - }, - "fs-extra": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", - "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", - "dev": true, - "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": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", - "dev": true, - "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==", - "dev": true, - "requires": { - "path-parse": "^1.0.6" - } - }, - "semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", - "dev": true, - "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==", - "dev": true - } - } - }, "@rushstack/rig-package": { "version": "0.3.17", "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.17.tgz", @@ -22592,9 +22783,9 @@ } }, "http-cache-semantics": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz", - "integrity": "sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", "dev": true }, "http-deceiver": { @@ -25338,7 +25529,7 @@ "numeral": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/numeral/-/numeral-2.0.6.tgz", - "integrity": "sha1-StCAk21EPCVhrtnyGX7//iX05QY=" + "integrity": "sha512-qaKRmtYPZ5qdw4jWJD6bxEf1FJEqllJrwxCLIm0sQU/A7v2/czigzOb+C2uSiFsa9lBUzeH7M1oK+Q+OLxL3kA==" }, "nwsapi": { "version": "2.2.2", @@ -26254,12 +26445,13 @@ "dev": true }, "resolve": { - "version": "1.20.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz", - "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==", + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", + "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", "requires": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" + "is-core-module": "^2.9.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" } }, "resolve-alpn": { @@ -27027,8 +27219,7 @@ "supports-preserve-symlinks-flag": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "dev": true + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==" }, "symbol-tree": { "version": "3.2.4", diff --git a/package.json b/package.json index cc17903d1..9f1094215 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "material-ui-popup-state": "^1.5.3", "monaco-editor": "^0.34.1", "notistack": "^2.0.8", - "numeral": "2.0.6", + "numeral": "^2.0.6", "prop-types": "^15.8.1", "react": "^17.0.2", "react-beautiful-dnd": "^13.1.1", @@ -50,8 +50,8 @@ "@babel/preset-env": "^7.20.2", "@babel/preset-react": "^7.18.6", "@babel/preset-typescript": "^7.18.6", - "@microsoft/api-documenter": "^7.13.65", - "@microsoft/api-extractor": "^7.18.17", + "@microsoft/api-documenter": "^7.21.3", + "@microsoft/api-extractor": "^7.34.2", "@pmmmwh/react-refresh-webpack-plugin": "^0.5.10", "@types/bcryptjs": "^2.4.2", "@types/escodegen": "^0.0.7", @@ -99,7 +99,7 @@ "url": "git+https://github.com/danielyxie/bitburner.git" }, "scripts": { - "doc": "npx api-extractor run && npx api-documenter markdown && rm input/bitburner.api.json && rm -r input", + "doc": "npx api-extractor run && npx api-documenter markdown && rm input/bitburner.api.json && rm -r input && git add markdown/ && git add tsdoc-metadata.json", "format": "prettier --write .", "format:report": "prettier -c .", "start": "http-server -p 8000", diff --git a/src/Augmentation/Augmentation.tsx b/src/Augmentation/Augmentation.tsx index df2896e5f..7b20ba596 100644 --- a/src/Augmentation/Augmentation.tsx +++ b/src/Augmentation/Augmentation.tsx @@ -3,7 +3,7 @@ import * as React from "react"; import { Faction } from "../Faction/Faction"; import { Factions } from "../Faction/Factions"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatPercent } from "../ui/formatNumber"; import { Money } from "../ui/React/Money"; import { Generic_fromJSON, Generic_toJSON, IReviverValue, Reviver } from "../utils/JSONReviver"; @@ -69,7 +69,7 @@ export interface IConstructorParams { function generateStatsDescription(mults: Multipliers, programs?: string[], startingMoney?: number): JSX.Element { // For a percentage that is <10, show x.xx%, otherwise show xx.x% - const f = (x: number) => numeralWrapper.formatPercentage(x, x - 1 < 0.1 ? 2 : 1); + const f = (x: number) => formatPercent(x, x - 1 < 0.1 ? 2 : 1); let desc = <>Effects:; if ( diff --git a/src/Augmentation/ui/AugmentationsRoot.tsx b/src/Augmentation/ui/AugmentationsRoot.tsx index f9eae92e5..7f19ca46c 100644 --- a/src/Augmentation/ui/AugmentationsRoot.tsx +++ b/src/Augmentation/ui/AugmentationsRoot.tsx @@ -22,7 +22,7 @@ import { Player } from "@player"; import { AugmentationNames } from "../data/AugmentationNames"; import { StaticAugmentations } from "../StaticAugmentations"; import { CONSTANTS } from "../../Constants"; -import { formatNumber } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; import { Info } from "@mui/icons-material"; import { Link } from "@mui/material"; import { AlertEvents } from "../../ui/React/AlertManager"; @@ -68,8 +68,8 @@ const EntropyDisplay = (): React.ReactElement => { Entropy Virus - Level {Player.entropy} - All multipliers decreased by: {formatNumber((1 - CONSTANTS.EntropyEffect ** Player.entropy) * 100, 3)}% - (multiplicative) + All multipliers decreased by:{" "} + {formatNumberNoSuffix((1 - CONSTANTS.EntropyEffect ** Player.entropy) * 100, 3)}% (multiplicative) ) : ( diff --git a/src/Augmentation/ui/PlayerMultipliers.tsx b/src/Augmentation/ui/PlayerMultipliers.tsx index 405eec112..43ac87cdb 100644 --- a/src/Augmentation/ui/PlayerMultipliers.tsx +++ b/src/Augmentation/ui/PlayerMultipliers.tsx @@ -5,7 +5,7 @@ import { Multipliers, defaultMultipliers, mergeMultipliers } from "../../PersonO import { BitNodeMultipliers } from "../../BitNode/BitNodeMultipliers"; import { Player } from "@player"; import { Settings } from "../../Settings/Settings"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatPercent } from "../../ui/formatNumber"; import { StaticAugmentations } from "../StaticAugmentations"; function calculateAugmentedStats(): Multipliers { @@ -26,12 +26,11 @@ interface IBitNodeModifiedStatsProps { function BitNodeModifiedStats(props: IBitNodeModifiedStatsProps): React.ReactElement { // If player doesn't have SF5 or if the property isn't affected by BitNode mults if (props.mult === 1 || Player.sourceFileLvl(5) === 0) - return {numeralWrapper.formatPercentage(props.base)}; + return {formatPercent(props.base)}; return ( - {numeralWrapper.formatPercentage(props.base)}{" "} - {numeralWrapper.formatPercentage(props.base * props.mult)} + {formatPercent(props.base)} {formatPercent(props.base * props.mult)} ); } diff --git a/src/Augmentation/ui/PurchasableAugmentations.tsx b/src/Augmentation/ui/PurchasableAugmentations.tsx index 37224fcba..52bd3a773 100644 --- a/src/Augmentation/ui/PurchasableAugmentations.tsx +++ b/src/Augmentation/ui/PurchasableAugmentations.tsx @@ -8,7 +8,7 @@ import React, { useState } from "react"; import { Faction } from "../../Faction/Faction"; import { Player } from "@player"; import { Settings } from "../../Settings/Settings"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatMoney, formatReputation } from "../../ui/formatNumber"; import { Augmentation } from "../Augmentation"; import { AugmentationNames } from "../data/AugmentationNames"; import { StaticAugmentations } from "../StaticAugmentations"; @@ -240,13 +240,13 @@ export function PurchasableAugmentation(props: IPurchasableAugProps): React.Reac cost} - value={numeralWrapper.formatMoney(cost)} + value={formatMoney(cost)} color={Settings.theme.money} /> {props.parent.rep !== undefined && ( = repCost} - value={`${numeralWrapper.formatReputation(repCost)} rep`} + value={`${formatReputation(repCost)} rep`} color={Settings.theme.rep} /> )} diff --git a/src/Bladeburner/Bladeburner.tsx b/src/Bladeburner/Bladeburner.tsx index 64c4573b9..cd5f59278 100644 --- a/src/Bladeburner/Bladeburner.tsx +++ b/src/Bladeburner/Bladeburner.tsx @@ -7,7 +7,7 @@ import { BlackOperation } from "./BlackOperation"; import { Operation } from "./Operation"; import { Contract } from "./Contract"; import { GeneralActions } from "./GeneralActions"; -import { formatNumber } from "../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../ui/formatNumber"; import { Skills } from "./Skills"; import { Skill } from "./Skill"; import { City } from "./City"; @@ -19,7 +19,7 @@ import { ConsoleHelpText } from "./data/Help"; import { exceptionAlert } from "../utils/helpers/exceptionAlert"; import { getRandomInt } from "../utils/helpers/getRandomInt"; import { BladeburnerConstants } from "./data/Constants"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatExp, formatMoney, formatPercent, formatBigNumber, formatStamina } from "../ui/formatNumber"; import { BitNodeMultipliers } from "../BitNode/BitNodeMultipliers"; import { addOffset } from "../utils/helpers/addOffset"; import { Factions, factionExists } from "../Faction/Factions"; @@ -470,7 +470,7 @@ export class Bladeburner { if (this.skills[skill.name] != null) { level = this.skills[skill.name]; } - this.postToConsole(skill.name + ": Level " + formatNumber(level, 0)); + this.postToConsole(skill.name + ": Level " + formatNumberNoSuffix(level, 0)); } this.postToConsole(" "); this.postToConsole("Effects: "); @@ -478,7 +478,7 @@ export class Bladeburner { for (let i = 0; i < multKeys.length; ++i) { const mult = this.skillMultipliers[multKeys[i]]; if (mult && mult !== 1) { - const mults = formatNumber(mult, 3); + const mults = formatNumberNoSuffix(mult, 3); switch (multKeys[i]) { case "successChanceAll": this.postToConsole("Total Success Chance: x" + mults); @@ -549,7 +549,7 @@ export class Bladeburner { if (this.skills[skill.name] !== undefined) { level = this.skills[skill.name]; } - this.postToConsole(skill.name + ": Level " + formatNumber(level)); + this.postToConsole(skill.name + ": Level " + formatNumberNoSuffix(level)); } else if (args[1].toLowerCase() === "level") { let currentLevel = 0; if (this.skills[skillName] && !isNaN(this.skills[skillName])) { @@ -564,7 +564,7 @@ export class Bladeburner { this.log(skill.name + " upgraded to Level " + this.skills[skillName]); } else { this.postToConsole( - "You do not have enough Skill Points to upgrade this. You need " + formatNumber(pointCost, 0), + "You do not have enough Skill Points to upgrade this. You need " + formatNumberNoSuffix(pointCost, 0), ); } } else { @@ -671,11 +671,11 @@ export class Bladeburner { this.postToConsole("Automation: " + (this.automateEnabled ? "enabled" : "disabled")); this.postToConsole( "When your stamina drops to " + - formatNumber(this.automateThreshLow, 0) + + formatNumberNoSuffix(this.automateThreshLow, 0) + ", you will automatically switch to " + this.automateActionLow.name + ". When your stamina recovers to " + - formatNumber(this.automateThreshHigh, 0) + + formatNumberNoSuffix(this.automateThreshHigh, 0) + ", you will automatically " + "switch to " + this.automateActionHigh.name + @@ -1120,7 +1120,7 @@ export class Bladeburner { } this.teamLost += losses; if (this.logging.ops && losses > 0) { - this.log("Lost " + formatNumber(losses, 0) + " team members during this " + action.name); + this.log("Lost " + formatNumberNoSuffix(losses, 0) + " team members during this " + action.name); } } @@ -1288,14 +1288,12 @@ export class Bladeburner { this.changeRank(person, gain); if (isOperation && this.logging.ops) { this.log( - `${person.whoAmI()}: ${ - action.name - } successfully completed! Gained ${numeralWrapper.formatReallyBigNumber(gain)} rank`, + `${person.whoAmI()}: ${action.name} successfully completed! Gained ${formatBigNumber(gain)} rank`, ); } else if (!isOperation && this.logging.contracts) { this.log( `${person.whoAmI()}: ${action.name} contract successfully completed! Gained ` + - `${numeralWrapper.formatReallyBigNumber(gain)} rank and ${numeralWrapper.formatMoney(moneyGain)}`, + `${formatBigNumber(gain)} rank and ${formatMoney(moneyGain)}`, ); } } @@ -1321,10 +1319,10 @@ export class Bladeburner { } let logLossText = ""; if (loss > 0) { - logLossText += "Lost " + formatNumber(loss, 3) + " rank. "; + logLossText += "Lost " + formatNumberNoSuffix(loss, 3) + " rank. "; } if (damage > 0) { - logLossText += "Took " + formatNumber(damage, 0) + " damage."; + logLossText += "Took " + formatNumberNoSuffix(damage, 0) + " damage."; } if (isOperation && this.logging.ops) { this.log(`${person.whoAmI()}: ` + action.name + " failed! " + logLossText); @@ -1376,7 +1374,11 @@ export class Bladeburner { if (this.logging.blackops) { this.log( - `${person.whoAmI()}: ` + action.name + " successful! Gained " + formatNumber(rankGain, 1) + " rank", + `${person.whoAmI()}: ` + + action.name + + " successful! Gained " + + formatNumberNoSuffix(rankGain, 1) + + " rank", ); } } else { @@ -1403,9 +1405,9 @@ export class Bladeburner { `${person.whoAmI()}: ` + action.name + " failed! Lost " + - formatNumber(rankLoss, 1) + + formatNumberNoSuffix(rankLoss, 1) + " rank and took " + - formatNumber(damage, 0) + + formatNumberNoSuffix(damage, 0) + " damage", ); } @@ -1428,7 +1430,9 @@ export class Bladeburner { } this.teamLost += losses; if (this.logging.blackops) { - this.log(`${person.whoAmI()}: You lost ${formatNumber(losses, 0)} team members during ${action.name}`); + this.log( + `${person.whoAmI()}: You lost ${formatNumberNoSuffix(losses, 0)} team members during ${action.name}`, + ); } } } catch (e: unknown) { @@ -1452,15 +1456,15 @@ export class Bladeburner { this.log( `${person.whoAmI()}: ` + "Training completed. Gained: " + - numeralWrapper.formatExp(strExpGain) + + formatExp(strExpGain) + " str exp, " + - numeralWrapper.formatExp(defExpGain) + + formatExp(defExpGain) + " def exp, " + - numeralWrapper.formatExp(dexExpGain) + + formatExp(dexExpGain) + " dex exp, " + - numeralWrapper.formatExp(agiExpGain) + + formatExp(agiExpGain) + " agi exp, " + - numeralWrapper.formatReallyBigNumber(staminaGain) + + formatBigNumber(staminaGain) + " max stamina", ); } @@ -1488,9 +1492,9 @@ export class Bladeburner { if (this.logging.general) { this.log( `${person.whoAmI()}: ` + - `Field analysis completed. Gained ${numeralWrapper.formatReallyBigNumber(rankGain)} rank, ` + - `${numeralWrapper.formatExp(hackingExpGain)} hacking exp, and ` + - `${numeralWrapper.formatExp(charismaExpGain)} charisma exp`, + `Field analysis completed. Gained ${formatBigNumber(rankGain)} rank, ` + + `${formatExp(hackingExpGain)} hacking exp, and ` + + `${formatExp(charismaExpGain)} charisma exp`, ); } break; @@ -1506,7 +1510,7 @@ export class Bladeburner { this.log( `${person.whoAmI()}: ` + "Successfully recruited a team member! Gained " + - numeralWrapper.formatExp(expGain) + + formatExp(expGain) + " charisma exp", ); } @@ -1517,7 +1521,7 @@ export class Bladeburner { this.log( `${person.whoAmI()}: ` + "Failed to recruit a team member. Gained " + - numeralWrapper.formatExp(expGain) + + formatExp(expGain) + " charisma exp", ); } @@ -1532,7 +1536,7 @@ export class Bladeburner { } if (this.logging.general) { this.log( - `${person.whoAmI()}: Diplomacy completed. Chaos levels in the current city fell by ${numeralWrapper.formatPercentage( + `${person.whoAmI()}: Diplomacy completed. Chaos levels in the current city fell by ${formatPercent( 1 - eff, )}`, ); @@ -1548,7 +1552,7 @@ export class Bladeburner { this.log( `${person.whoAmI()}: Rested in Hyperbolic Regeneration Chamber. Restored ${ BladeburnerConstants.HrcHpGain - } HP and gained ${numeralWrapper.formatStamina(staminaGain)} stamina`, + } HP and gained ${formatStamina(staminaGain)} stamina`, ); } break; diff --git a/src/Bladeburner/ui/BlackOpElem.tsx b/src/Bladeburner/ui/BlackOpElem.tsx index 22edce2da..f403f73bd 100644 --- a/src/Bladeburner/ui/BlackOpElem.tsx +++ b/src/Bladeburner/ui/BlackOpElem.tsx @@ -1,5 +1,6 @@ import React, { useState } from "react"; -import { formatNumber, convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { ActionTypes } from "../data/ActionTypes"; import { createProgressBarText } from "../../utils/helpers/createProgressBarText"; import { TeamSizeButton } from "./TeamSizeButton"; @@ -55,8 +56,8 @@ export function BlackOpElem(props: IProps): React.ReactElement { <> - (IN PROGRESS - {formatNumber(computedActionTimeCurrent, 0)} /{" "} - {formatNumber(props.bladeburner.actionTimeToComplete, 0)}) + (IN PROGRESS - {formatNumberNoSuffix(computedActionTimeCurrent, 0)} /{" "} + {formatNumberNoSuffix(props.bladeburner.actionTimeToComplete, 0)}) {createProgressBarText({ @@ -85,7 +86,7 @@ export function BlackOpElem(props: IProps): React.ReactElement {

- Required Rank: {formatNumber(props.action.reqdRank, 0)} + Required Rank: {formatNumberNoSuffix(props.action.reqdRank, 0)}
diff --git a/src/Bladeburner/ui/ContractElem.tsx b/src/Bladeburner/ui/ContractElem.tsx index 8c1a0e1c7..2cfabae01 100644 --- a/src/Bladeburner/ui/ContractElem.tsx +++ b/src/Bladeburner/ui/ContractElem.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; import { ActionTypes } from "../data/ActionTypes"; import { createProgressBarText } from "../../utils/helpers/createProgressBarText"; -import { formatNumber, convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { Contracts } from "../data/Contracts"; import { Bladeburner } from "../Bladeburner"; import { Action } from "../Action"; @@ -11,7 +11,7 @@ import { CopyableText } from "../../ui/React/CopyableText"; import { ActionLevel } from "./ActionLevel"; import { Autolevel } from "./Autolevel"; import { StartButton } from "./StartButton"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatNumberNoSuffix, formatBigNumber } from "../../ui/formatNumber"; import Typography from "@mui/material/Typography"; import Paper from "@mui/material/Paper"; @@ -43,8 +43,9 @@ export function ContractElem(props: IProps): React.ReactElement { {isActive ? ( <> - (IN PROGRESS - {formatNumber(computedActionTimeCurrent, 0)} /{" "} - {formatNumber(props.bladeburner.actionTimeToComplete, 0)}) + (IN PROGRESS -{" "} + {formatNumberNoSuffix(computedActionTimeCurrent, 0)} /{" "} + {formatNumberNoSuffix(props.bladeburner.actionTimeToComplete, 0)}) {createProgressBarText({ @@ -76,11 +77,11 @@ export function ContractElem(props: IProps): React.ReactElement {
Time Required: {convertTimeMsToTimeElapsedString(actionTime * 1000)}
- Contracts remaining: {numeralWrapper.formatReallyBigNumber(Math.floor(props.action.count), 3)} + Contracts remaining: {formatBigNumber(Math.floor(props.action.count))}
- Successes: {numeralWrapper.formatReallyBigNumber(props.action.successes, 3)} + Successes: {formatBigNumber(props.action.successes)}
- Failures: {numeralWrapper.formatReallyBigNumber(props.action.failures, 3)} + Failures: {formatBigNumber(props.action.failures)}
diff --git a/src/Bladeburner/ui/GeneralActionElem.tsx b/src/Bladeburner/ui/GeneralActionElem.tsx index 3ddee1b7b..fdd07fb48 100644 --- a/src/Bladeburner/ui/GeneralActionElem.tsx +++ b/src/Bladeburner/ui/GeneralActionElem.tsx @@ -1,7 +1,8 @@ import React, { useState } from "react"; import { ActionTypes } from "../data/ActionTypes"; import { createProgressBarText } from "../../utils/helpers/createProgressBarText"; -import { formatNumber, convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { Bladeburner } from "../Bladeburner"; import { Action } from "../Action"; import { GeneralActions } from "../data/GeneralActions"; @@ -59,8 +60,8 @@ export function GeneralActionElem(props: IProps): React.ReactElement { <> - (IN PROGRESS - {formatNumber(computedActionTimeCurrent, 0)} /{" "} - {formatNumber(props.bladeburner.actionTimeToComplete, 0)}) + (IN PROGRESS - {formatNumberNoSuffix(computedActionTimeCurrent, 0)} /{" "} + {formatNumberNoSuffix(props.bladeburner.actionTimeToComplete, 0)}) {createProgressBarText({ @@ -89,7 +90,7 @@ export function GeneralActionElem(props: IProps): React.ReactElement { {successChance !== -1 && ( <>
- Estimated success chance: {formatNumber(successChance * 100, 1)}% + Estimated success chance: {formatNumberNoSuffix(successChance * 100, 1)}% )} diff --git a/src/Bladeburner/ui/OperationElem.tsx b/src/Bladeburner/ui/OperationElem.tsx index ae745da66..866b63643 100644 --- a/src/Bladeburner/ui/OperationElem.tsx +++ b/src/Bladeburner/ui/OperationElem.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; import { ActionTypes } from "../data/ActionTypes"; import { createProgressBarText } from "../../utils/helpers/createProgressBarText"; -import { formatNumber, convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { SuccessChance } from "./SuccessChance"; import { ActionLevel } from "./ActionLevel"; import { Autolevel } from "./Autolevel"; @@ -12,7 +12,7 @@ import { Operation } from "../Operation"; import { Operations } from "../data/Operations"; import { Player } from "@player"; import { CopyableText } from "../../ui/React/CopyableText"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatNumberNoSuffix, formatBigNumber } from "../../ui/formatNumber"; import Typography from "@mui/material/Typography"; import Paper from "@mui/material/Paper"; @@ -44,8 +44,9 @@ export function OperationElem(props: IProps): React.ReactElement { {isActive ? ( <> - (IN PROGRESS - {formatNumber(computedActionTimeCurrent, 0)} /{" "} - {formatNumber(props.bladeburner.actionTimeToComplete, 0)}) + (IN PROGRESS -{" "} + {formatNumberNoSuffix(computedActionTimeCurrent, 0)} /{" "} + {formatNumberNoSuffix(props.bladeburner.actionTimeToComplete, 0)}) {createProgressBarText({ @@ -79,11 +80,11 @@ export function OperationElem(props: IProps): React.ReactElement {
Time Required: {convertTimeMsToTimeElapsedString(actionTime * 1000)}
- Operations remaining: {numeralWrapper.formatReallyBigNumber(Math.floor(props.action.count), 3)} + Operations remaining: {formatBigNumber(Math.floor(props.action.count))}
- Successes: {numeralWrapper.formatReallyBigNumber(props.action.successes, 3)} + Successes: {formatBigNumber(props.action.successes)}
- Failures: {numeralWrapper.formatReallyBigNumber(props.action.failures, 3)} + Failures: {formatBigNumber(props.action.failures)}
diff --git a/src/Bladeburner/ui/SkillElem.tsx b/src/Bladeburner/ui/SkillElem.tsx index 8588ca8fb..2f7181a6e 100644 --- a/src/Bladeburner/ui/SkillElem.tsx +++ b/src/Bladeburner/ui/SkillElem.tsx @@ -1,6 +1,6 @@ import React from "react"; import { CopyableText } from "../../ui/React/CopyableText"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatBigNumber } from "../../ui/formatNumber"; import { Bladeburner } from "../Bladeburner"; import Typography from "@mui/material/Typography"; import IconButton from "@mui/material/IconButton"; @@ -48,11 +48,11 @@ export function SkillElem(props: IProps): React.ReactElement { )} - Level: {numeralWrapper.formatReallyBigNumber(currentLevel, 3)} + Level: {formatBigNumber(currentLevel)} {maxLvl ? ( MAX LEVEL ) : ( - Skill Points required: {numeralWrapper.formatReallyBigNumber(pointCost, 3)} + Skill Points required: {formatBigNumber(pointCost)} )} {props.skill.desc} diff --git a/src/Bladeburner/ui/SkillPage.tsx b/src/Bladeburner/ui/SkillPage.tsx index 4dcbbe9c2..e21633479 100644 --- a/src/Bladeburner/ui/SkillPage.tsx +++ b/src/Bladeburner/ui/SkillPage.tsx @@ -2,7 +2,7 @@ import React, { useState } from "react"; import { SkillList } from "./SkillList"; import { BladeburnerConstants } from "../data/Constants"; import { Bladeburner } from "../Bladeburner"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatBigNumber } from "../../ui/formatNumber"; import Typography from "@mui/material/Typography"; interface IProps { bladeburner: Bladeburner; @@ -19,7 +19,7 @@ export function SkillPage(props: IProps): React.ReactElement { return ( <> - Skill Points: {numeralWrapper.formatReallyBigNumber(props.bladeburner.skillPoints, 3)} + Skill Points: {formatBigNumber(props.bladeburner.skillPoints)} You will gain one skill point every {BladeburnerConstants.RanksPerSkillPoint} ranks. @@ -28,68 +28,34 @@ export function SkillPage(props: IProps): React.ReactElement { skills with each other is multiplicative. {valid(mults["successChanceAll"]) && ( - - Total Success Chance: x{numeralWrapper.formatReallyBigNumber(mults["successChanceAll"], 3)} - + Total Success Chance: x{formatBigNumber(mults["successChanceAll"])} )} {valid(mults["successChanceStealth"]) && ( - - Stealth Success Chance: x{numeralWrapper.formatReallyBigNumber(mults["successChanceStealth"], 3)} - + Stealth Success Chance: x{formatBigNumber(mults["successChanceStealth"])} )} {valid(mults["successChanceKill"]) && ( - - Retirement Success Chance: x{numeralWrapper.formatReallyBigNumber(mults["successChanceKill"], 3)} - + Retirement Success Chance: x{formatBigNumber(mults["successChanceKill"])} )} {valid(mults["successChanceContract"]) && ( - - Contract Success Chance: x{numeralWrapper.formatReallyBigNumber(mults["successChanceContract"], 3)} - + Contract Success Chance: x{formatBigNumber(mults["successChanceContract"])} )} {valid(mults["successChanceOperation"]) && ( - - Operation Success Chance: x{numeralWrapper.formatReallyBigNumber(mults["successChanceOperation"], 3)} - + Operation Success Chance: x{formatBigNumber(mults["successChanceOperation"])} )} {valid(mults["successChanceEstimate"]) && ( - - Synthoid Data Estimate: x{numeralWrapper.formatReallyBigNumber(mults["successChanceEstimate"], 3)} - - )} - {valid(mults["actionTime"]) && ( - Action Time: x{numeralWrapper.formatReallyBigNumber(mults["actionTime"], 3)} - )} - {valid(mults["effHack"]) && ( - Hacking Skill: x{numeralWrapper.formatReallyBigNumber(mults["effHack"], 3)} - )} - {valid(mults["effStr"]) && ( - Strength: x{numeralWrapper.formatReallyBigNumber(mults["effStr"], 3)} - )} - {valid(mults["effDef"]) && ( - Defense: x{numeralWrapper.formatReallyBigNumber(mults["effDef"], 3)} - )} - {valid(mults["effDex"]) && ( - Dexterity: x{numeralWrapper.formatReallyBigNumber(mults["effDex"], 3)} - )} - {valid(mults["effAgi"]) && ( - Agility: x{numeralWrapper.formatReallyBigNumber(mults["effAgi"], 3)} - )} - {valid(mults["effCha"]) && ( - Charisma: x{numeralWrapper.formatReallyBigNumber(mults["effCha"], 3)} - )} - {valid(mults["effInt"]) && ( - Intelligence: x{numeralWrapper.formatReallyBigNumber(mults["effInt"], 3)} - )} - {valid(mults["stamina"]) && ( - Stamina: x{numeralWrapper.formatReallyBigNumber(mults["stamina"], 3)} - )} - {valid(mults["money"]) && ( - Contract Money: x{numeralWrapper.formatReallyBigNumber(mults["money"], 3)} - )} - {valid(mults["expGain"]) && ( - Exp Gain: x{numeralWrapper.formatReallyBigNumber(mults["expGain"], 3)} + Synthoid Data Estimate: x{formatBigNumber(mults["successChanceEstimate"])} )} + {valid(mults["actionTime"]) && Action Time: x{formatBigNumber(mults["actionTime"])}} + {valid(mults["effHack"]) && Hacking Skill: x{formatBigNumber(mults["effHack"])}} + {valid(mults["effStr"]) && Strength: x{formatBigNumber(mults["effStr"])}} + {valid(mults["effDef"]) && Defense: x{formatBigNumber(mults["effDef"])}} + {valid(mults["effDex"]) && Dexterity: x{formatBigNumber(mults["effDex"])}} + {valid(mults["effAgi"]) && Agility: x{formatBigNumber(mults["effAgi"])}} + {valid(mults["effCha"]) && Charisma: x{formatBigNumber(mults["effCha"])}} + {valid(mults["effInt"]) && Intelligence: x{formatBigNumber(mults["effInt"])}} + {valid(mults["stamina"]) && Stamina: x{formatBigNumber(mults["stamina"])}} + {valid(mults["money"]) && Contract Money: x{formatBigNumber(mults["money"])}} + {valid(mults["expGain"]) && Exp Gain: x{formatBigNumber(mults["expGain"])}} setRerender((old) => !old)} /> ); diff --git a/src/Bladeburner/ui/Stats.tsx b/src/Bladeburner/ui/Stats.tsx index 2f3385345..b346c2423 100644 --- a/src/Bladeburner/ui/Stats.tsx +++ b/src/Bladeburner/ui/Stats.tsx @@ -1,9 +1,9 @@ import React, { useState, useEffect } from "react"; -import { formatNumber, convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { BladeburnerConstants } from "../data/Constants"; import { Player } from "@player"; import { Money } from "../../ui/React/Money"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatNumberNoSuffix, formatPopulation, formatBigNumber } from "../../ui/formatNumber"; import { Factions } from "../../Faction/Factions"; import { Router } from "../../ui/GameRoot"; import { joinFaction } from "../../Faction/FactionHelpers"; @@ -59,7 +59,7 @@ export function Stats(props: IProps): React.ReactElement { Your rank within the Bladeburner division.}> - Rank: {numeralWrapper.formatReallyBigNumber(props.bladeburner.rank)} + Rank: {formatBigNumber(props.bladeburner.rank)}
@@ -88,17 +88,16 @@ export function Stats(props: IProps): React.ReactElement { } > - Stamina: {numeralWrapper.formatReallyBigNumber(props.bladeburner.stamina)} /{" "} - {numeralWrapper.formatReallyBigNumber(props.bladeburner.maxStamina)} + Stamina: {formatBigNumber(props.bladeburner.stamina)} / {formatBigNumber(props.bladeburner.maxStamina)} - Stamina Penalty: {formatNumber((1 - props.bladeburner.calculateStaminaPenalty()) * 100, 1)}% + Stamina Penalty: {formatNumberNoSuffix((1 - props.bladeburner.calculateStaminaPenalty()) * 100, 1)}%
- Team Size: {formatNumber(props.bladeburner.teamSize, 0)} - Team Members Lost: {formatNumber(props.bladeburner.teamLost, 0)} + Team Size: {formatNumberNoSuffix(props.bladeburner.teamSize, 0)} + Team Members Lost: {formatNumberNoSuffix(props.bladeburner.teamLost, 0)}
Num Times Hospitalized: {props.bladeburner.numHosp} @@ -116,7 +115,7 @@ export function Stats(props: IProps): React.ReactElement { } > - Est. Synthoid Population: {numeralWrapper.formatPopulation(props.bladeburner.getCurrentCity().popEst)} + Est. Synthoid Population: {formatPopulation(props.bladeburner.getCurrentCity().popEst)} @@ -129,7 +128,9 @@ export function Stats(props: IProps): React.ReactElement { } > - Synthoid Communities: {formatNumber(props.bladeburner.getCurrentCity().comms, 0)} + + Synthoid Communities: {formatNumberNoSuffix(props.bladeburner.getCurrentCity().comms, 0)} + @@ -141,9 +142,7 @@ export function Stats(props: IProps): React.ReactElement { } > - - City Chaos: {numeralWrapper.formatReallyBigNumber(props.bladeburner.getCurrentCity().chaos)} - + City Chaos: {formatBigNumber(props.bladeburner.getCurrentCity().chaos)}
@@ -169,16 +168,16 @@ export function Stats(props: IProps): React.ReactElement {
)} - Skill Points: {numeralWrapper.formatReallyBigNumber(props.bladeburner.skillPoints)} + Skill Points: {formatBigNumber(props.bladeburner.skillPoints)}
- Aug. Success Chance mult: {formatNumber(Player.mults.bladeburner_success_chance * 100, 1)}% + Aug. Success Chance mult: {formatNumberNoSuffix(Player.mults.bladeburner_success_chance * 100, 1)}%
- Aug. Max Stamina mult: {formatNumber(Player.mults.bladeburner_max_stamina * 100, 1)}% + Aug. Max Stamina mult: {formatNumberNoSuffix(Player.mults.bladeburner_max_stamina * 100, 1)}%
- Aug. Stamina Gain mult: {formatNumber(Player.mults.bladeburner_stamina_gain * 100, 1)}% + Aug. Stamina Gain mult: {formatNumberNoSuffix(Player.mults.bladeburner_stamina_gain * 100, 1)}%
- Aug. Field Analysis mult: {formatNumber(Player.mults.bladeburner_analysis * 100, 1)}% + Aug. Field Analysis mult: {formatNumberNoSuffix(Player.mults.bladeburner_analysis * 100, 1)}% diff --git a/src/Bladeburner/ui/SuccessChance.tsx b/src/Bladeburner/ui/SuccessChance.tsx index a746f0c82..b6bd960d9 100644 --- a/src/Bladeburner/ui/SuccessChance.tsx +++ b/src/Bladeburner/ui/SuccessChance.tsx @@ -1,5 +1,5 @@ import React from "react"; -import { formatNumber } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; import { StealthIcon } from "./StealthIcon"; import { KillIcon } from "./KillIcon"; import { Action } from "../Action"; @@ -16,11 +16,12 @@ export function SuccessChance(props: IProps): React.ReactElement { let chance = <>; if (estimatedSuccessChance[0] === estimatedSuccessChance[1]) { - chance = <>{formatNumber(estimatedSuccessChance[0] * 100, 1)}%; + chance = <>{formatNumberNoSuffix(estimatedSuccessChance[0] * 100, 1)}%; } else { chance = ( <> - {formatNumber(estimatedSuccessChance[0] * 100, 1)}% ~ {formatNumber(estimatedSuccessChance[1] * 100, 1)}% + {formatNumberNoSuffix(estimatedSuccessChance[0] * 100, 1)}% ~{" "} + {formatNumberNoSuffix(estimatedSuccessChance[1] * 100, 1)}% ); } diff --git a/src/Bladeburner/ui/TeamSizeButton.tsx b/src/Bladeburner/ui/TeamSizeButton.tsx index 9972afb35..17bdd22d2 100644 --- a/src/Bladeburner/ui/TeamSizeButton.tsx +++ b/src/Bladeburner/ui/TeamSizeButton.tsx @@ -2,7 +2,7 @@ import React, { useState } from "react"; import { Operation } from "../Operation"; import { Bladeburner } from "../Bladeburner"; import { TeamSizeModal } from "./TeamSizeModal"; -import { formatNumber } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; import Button from "@mui/material/Button"; interface IProps { action: Operation; @@ -14,7 +14,7 @@ export function TeamSizeButton(props: IProps): React.ReactElement { return ( <> setOpen(false)} action={props.action} bladeburner={props.bladeburner} /> diff --git a/src/Corporation/ui/IndustryOffice.tsx b/src/Corporation/ui/IndustryOffice.tsx index 08d2ec950..f7adebbdc 100644 --- a/src/Corporation/ui/IndustryOffice.tsx +++ b/src/Corporation/ui/IndustryOffice.tsx @@ -7,7 +7,7 @@ import { EmployeePositions } from "../data/Enums"; import { BuyCoffee } from "../Actions"; import { MoneyCost } from "./MoneyCost"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatCorpStat } from "../../ui/formatNumber"; import { UpgradeOfficeSizeModal } from "./modals/UpgradeOfficeSizeModal"; import { ThrowPartyModal } from "./modals/ThrowPartyModal"; @@ -115,7 +115,7 @@ function AutoManagement(props: IProps): React.ReactElement { Avg Employee Morale: - {numeralWrapper.format(props.office.avgMor, "0.000")} + {formatCorpStat(props.office.avgMor)} @@ -123,7 +123,7 @@ function AutoManagement(props: IProps): React.ReactElement { Avg Employee Happiness: - {numeralWrapper.format(props.office.avgHap, "0.000")} + {formatCorpStat(props.office.avgHap)} @@ -131,7 +131,7 @@ function AutoManagement(props: IProps): React.ReactElement { Avg Employee Energy: - {numeralWrapper.format(props.office.avgEne, "0.000")} + {formatCorpStat(props.office.avgEne)} @@ -139,9 +139,7 @@ function AutoManagement(props: IProps): React.ReactElement { Avg Employee Experience: - - {numeralWrapper.format(props.office.totalExp / props.office.totalEmployees || 0, "0.000")} - + {formatCorpStat(props.office.totalExp / props.office.totalEmployees || 0)} @@ -171,9 +169,7 @@ function AutoManagement(props: IProps): React.ReactElement { - - {numeralWrapper.format(division.getOfficeProductivity(props.office), "0.000")} - + {formatCorpStat(division.getOfficeProductivity(props.office))} @@ -192,12 +188,7 @@ function AutoManagement(props: IProps): React.ReactElement { - {numeralWrapper.format( - division.getOfficeProductivity(props.office, { - forProduct: true, - }), - "0.000", - )} + {formatCorpStat(division.getOfficeProductivity(props.office, { forProduct: true }))} @@ -210,7 +201,7 @@ function AutoManagement(props: IProps): React.ReactElement { - x{numeralWrapper.format(division.getBusinessFactor(props.office), "0.000")} + x{formatCorpStat(division.getBusinessFactor(props.office))} diff --git a/src/Corporation/ui/IndustryOverview.tsx b/src/Corporation/ui/IndustryOverview.tsx index bb84a8d6d..1ae5101e2 100644 --- a/src/Corporation/ui/IndustryOverview.tsx +++ b/src/Corporation/ui/IndustryOverview.tsx @@ -4,7 +4,7 @@ import React, { useState } from "react"; import { IndustryType } from "../data/Enums"; import { HireAdVert } from "../Actions"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatBigNumber } from "../../ui/formatNumber"; import { createProgressBarText } from "../../utils/helpers/createProgressBarText"; import { MakeProductModal } from "./modals/MakeProductModal"; import { ResearchModal } from "./modals/ResearchModal"; @@ -128,8 +128,8 @@ export function IndustryOverview(props: IProps): React.ReactElement {
{advertisingInfo !== false && ( @@ -139,15 +139,15 @@ export function IndustryOverview(props: IProps): React.ReactElement { Total multiplier for this industry's sales due to its awareness and popularity } > - Advertising Multiplier: x{numeralWrapper.formatReallyBigNumber(totalAdvertisingFac)} + Advertising Multiplier: x{formatBigNumber(totalAdvertisingFac)} )}
@@ -168,7 +168,7 @@ export function IndustryOverview(props: IProps): React.ReactElement { } > - Production Multiplier: {numeralWrapper.formatReallyBigNumber(division.prodMult)} + Production Multiplier: {formatBigNumber(division.prodMult)} setHelpOpen(true)}> @@ -207,7 +207,7 @@ export function IndustryOverview(props: IProps): React.ReactElement { } > - Scientific Research: {numeralWrapper.formatReallyBigNumber(division.sciResearch)} + Scientific Research: {formatBigNumber(division.sciResearch)} - Prod: {numeralWrapper.format(product.data[city][1], nfB)}/s + Prod: {formatBigNumber(product.data[city][1])}/s
- Sell: {numeralWrapper.format(product.data[city][2], nfB)} /s + Sell: {formatBigNumber(product.data[city][2])} /s } > - {product.name}: {numeralWrapper.format(product.data[city][0], nfB)} ( - {numeralWrapper.format(totalGain, nfB)} + {product.name}: {formatBigNumber(product.data[city][0])} ({formatBigNumber(totalGain)} /s) @@ -144,26 +138,26 @@ export function ProductElem(props: IProductProps): React.ReactElement { - Quality: {numeralWrapper.format(product.qlt, nf)}
- Performance: {numeralWrapper.format(product.per, nf)}
- Durability: {numeralWrapper.format(product.dur, nf)}
- Reliability: {numeralWrapper.format(product.rel, nf)}
- Aesthetics: {numeralWrapper.format(product.aes, nf)}
- Features: {numeralWrapper.format(product.fea, nf)} + Quality: {formatCorpStat(product.qlt)}
+ Performance: {formatCorpStat(product.per)}
+ Durability: {formatCorpStat(product.dur)}
+ Reliability: {formatCorpStat(product.rel)}
+ Aesthetics: {formatCorpStat(product.aes)}
+ Features: {formatCorpStat(product.fea)} {corp.unlockUpgrades[2] === 1 &&
} - {corp.unlockUpgrades[2] === 1 && "Demand: " + numeralWrapper.format(product.dmd, nf)} + {corp.unlockUpgrades[2] === 1 && "Demand: " + formatCorpStat(product.dmd)} {corp.unlockUpgrades[3] === 1 &&
} - {corp.unlockUpgrades[3] === 1 && "Competition: " + numeralWrapper.format(product.cmp, nf)} + {corp.unlockUpgrades[3] === 1 && "Competition: " + formatCorpStat(product.cmp)} } > - Rating: {numeralWrapper.format(product.rat, nf)} + Rating: {formatCorpStat(product.rat)} An estimate of the material cost it takes to create this Product.}> - Est. Production Cost: {numeralWrapper.formatMoney(product.pCost / corpConstants.baseProductProfitMult)} + Est. Production Cost: {formatMoney(product.pCost / corpConstants.baseProductProfitMult)} @@ -176,7 +170,7 @@ export function ProductElem(props: IProductProps): React.ReactElement { } > - Est. Market Price: {numeralWrapper.formatMoney(product.pCost)} + Est. Market Price: {formatMoney(product.pCost)} diff --git a/src/Corporation/ui/modals/BribeFactionModal.tsx b/src/Corporation/ui/modals/BribeFactionModal.tsx index 8eccd2032..ec9a46951 100644 --- a/src/Corporation/ui/modals/BribeFactionModal.tsx +++ b/src/Corporation/ui/modals/BribeFactionModal.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; import { Factions } from "../../../Faction/Factions"; import * as corpConstants from "../../data/Constants"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatReputation } from "../../../ui/formatNumber"; import { dialogBoxCreate } from "../../../ui/React/DialogBox"; import { Modal } from "../../../ui/React/Modal"; import { Player } from "@player"; @@ -46,11 +46,7 @@ export function BribeFactionModal(props: IProps): React.ReactElement { return "ERROR: You do not have this much money to bribe with"; } else { return ( - "You will gain " + - numeralWrapper.formatReputation(repGain(money)) + - " reputation with " + - selectedFaction + - " with this bribe" + "You will gain " + formatReputation(repGain(money)) + " reputation with " + selectedFaction + " with this bribe" ); } } @@ -59,7 +55,7 @@ export function BribeFactionModal(props: IProps): React.ReactElement { const fac = Factions[selectedFaction]; if (disabled) return; const rep = repGain(money); - dialogBoxCreate(`You gained ${numeralWrapper.formatReputation(rep)} reputation with ${fac.name} by bribing them.`); + dialogBoxCreate(`You gained ${formatReputation(rep)} reputation with ${fac.name} by bribing them.`); fac.playerReputation += rep; corp.funds = corp.funds - money; props.onClose(); diff --git a/src/Corporation/ui/modals/BuybackSharesModal.tsx b/src/Corporation/ui/modals/BuybackSharesModal.tsx index 31d936240..6333c3862 100644 --- a/src/Corporation/ui/modals/BuybackSharesModal.tsx +++ b/src/Corporation/ui/modals/BuybackSharesModal.tsx @@ -1,6 +1,6 @@ import React, { useState } from "react"; import { Modal } from "../../../ui/React/Modal"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatBigNumber, formatMoney } from "../../../ui/formatNumber"; import { Player } from "@player"; import { useCorporation } from "../Context"; import Typography from "@mui/material/Typography"; @@ -49,14 +49,14 @@ export function BuybackSharesModal(props: IProps): React.ReactElement { } else if (shares > corp.issuedShares) { return ( <> - There are not this many shares available to buy back. There are only{" "} - {numeralWrapper.formatBigNumber(corp.issuedShares)} outstanding shares. + There are not this many shares available to buy back. There are only {formatBigNumber(corp.issuedShares)}{" "} + outstanding shares. ); } else { return ( <> - Purchase {shares} shares for a total of {numeralWrapper.formatMoney(shares * buybackPrice)} + Purchase {shares} shares for a total of {formatMoney(shares * buybackPrice)} ); } @@ -76,8 +76,8 @@ export function BuybackSharesModal(props: IProps): React.ReactElement { To purchase these shares, you must use your own money (NOT your Corporation's funds).

- The current buyback price of your company's stock is {numeralWrapper.formatMoney(buybackPrice)}. Your company - currently has {numeralWrapper.formatBigNumber(corp.issuedShares)} outstanding stock shares. + The current buyback price of your company's stock is {formatMoney(buybackPrice)}. Your company currently has{" "} + {formatBigNumber(corp.issuedShares)} outstanding stock shares.
diff --git a/src/Corporation/ui/modals/FindInvestorsModal.tsx b/src/Corporation/ui/modals/FindInvestorsModal.tsx index 8a2eb34d0..e1d0b168f 100644 --- a/src/Corporation/ui/modals/FindInvestorsModal.tsx +++ b/src/Corporation/ui/modals/FindInvestorsModal.tsx @@ -1,5 +1,5 @@ import React from "react"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney, formatPercent, formatShares } from "../../../ui/formatNumber"; import * as corpConstants from "../../data/Constants"; import { Modal } from "../../../ui/React/Modal"; import { useCorporation } from "../Context"; @@ -37,9 +37,8 @@ export function FindInvestorsModal(props: IProps): React.ReactElement { return ( - An investment firm has offered you {numeralWrapper.formatMoney(funding)} in funding in exchange for a{" "} - {numeralWrapper.format(percShares * 100, "0.000a")}% stake in the company ( - {numeralWrapper.format(investShares, "0.000a")} shares). + An investment firm has offered you {formatMoney(funding)} in funding in exchange for a{" "} + {formatPercent(percShares, 3)} stake in the company ({formatShares(investShares)} shares).

Do you accept or reject this offer? diff --git a/src/Corporation/ui/modals/GoPublicModal.tsx b/src/Corporation/ui/modals/GoPublicModal.tsx index f1b16addb..620fa19ee 100644 --- a/src/Corporation/ui/modals/GoPublicModal.tsx +++ b/src/Corporation/ui/modals/GoPublicModal.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; import { dialogBoxCreate } from "../../../ui/React/DialogBox"; import { Modal } from "../../../ui/React/Modal"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney, formatShares } from "../../../ui/formatNumber"; import { useCorporation } from "../Context"; import Typography from "@mui/material/Typography"; import Button from "@mui/material/Button"; @@ -38,8 +38,7 @@ export function GoPublicModal(props: IProps): React.ReactElement { corp.addFunds(shares * initialSharePrice); props.rerender(); dialogBoxCreate( - `You took your ${corp.name} public and earned ` + - `${numeralWrapper.formatMoney(shares * initialSharePrice)} in your IPO`, + `You took your ${corp.name} public and earned ` + `${formatMoney(shares * initialSharePrice)} in your IPO`, ); props.onClose(); } @@ -52,11 +51,11 @@ export function GoPublicModal(props: IProps): React.ReactElement { Enter the number of shares you would like to issue for your IPO. These shares will be publicly sold and you will - no longer own them. Your Corporation will receive {numeralWrapper.formatMoney(initialSharePrice)} per share (the - IPO money will be deposited directly into your Corporation's funds). + no longer own them. Your Corporation will receive {formatMoney(initialSharePrice)} per share (the IPO money will + be deposited directly into your Corporation's funds).

- You have a total of {numeralWrapper.format(corp.numShares, "0.000a")} of shares that you can issue. + You have a total of {formatShares(corp.numShares)} shares that you can issue. diff --git a/src/Corporation/ui/modals/IssueNewSharesModal.tsx b/src/Corporation/ui/modals/IssueNewSharesModal.tsx index 306c9f9aa..f12bc5094 100644 --- a/src/Corporation/ui/modals/IssueNewSharesModal.tsx +++ b/src/Corporation/ui/modals/IssueNewSharesModal.tsx @@ -1,5 +1,5 @@ import React, { useState } from "react"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney, formatShares } from "../../../ui/formatNumber"; import { dialogBoxCreate } from "../../../ui/React/DialogBox"; import { Modal } from "../../../ui/React/Modal"; import { useCorporation } from "../Context"; @@ -37,8 +37,7 @@ function EffectText(props: IEffectTextProps): React.ReactElement { return ( - Issue {numeralWrapper.format(newShares, "0.000a")} new shares for{" "} - {numeralWrapper.formatMoney(newShares * newSharePrice)}? + Issue {formatShares(newShares)} new shares for {formatMoney(newShares * newSharePrice)}? ); } @@ -66,12 +65,10 @@ export function IssueNewSharesModal(props: IProps): React.ReactElement { props.onClose(); let dialogContents = - `Issued ${numeralWrapper.format(newShares, "0.000a")} new shares` + - ` and raised ${numeralWrapper.formatMoney(profit)}.` + - (privateShares > 0) - ? "\n" + numeralWrapper.format(privateShares, "0.000a") + "of these shares were bought by private investors." + `Issued ${formatShares(newShares)} new shares` + ` and raised ${formatMoney(profit)}.` + (privateShares > 0) + ? "\n" + formatShares(privateShares) + "of these shares were bought by private investors." : ""; - dialogContents += `\n\nStock price decreased to ${numeralWrapper.formatMoney(corp.sharePrice)}`; + dialogContents += `\n\nStock price decreased to ${formatMoney(corp.sharePrice)}`; dialogBoxCreate(dialogContents); } @@ -85,7 +82,7 @@ export function IssueNewSharesModal(props: IProps): React.ReactElement { You can issue new equity shares (i.e. stocks) in order to raise capital for your corporation.

-  * You can issue at most {numeralWrapper.format(maxNewShares, "0.000a")} new shares +  * You can issue at most {formatShares(maxNewShares)} new shares
 * New shares are sold at a 10% discount
diff --git a/src/Corporation/ui/modals/MaterialMarketTaModal.tsx b/src/Corporation/ui/modals/MaterialMarketTaModal.tsx index c78710f37..265202193 100644 --- a/src/Corporation/ui/modals/MaterialMarketTaModal.tsx +++ b/src/Corporation/ui/modals/MaterialMarketTaModal.tsx @@ -1,5 +1,5 @@ import React, { useState } from "react"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney, formatPreciseMultiplier } from "../../../ui/formatNumber"; import { Material } from "../../Material"; import { Modal } from "../../../ui/React/Modal"; import { useDivision } from "../Context"; @@ -54,8 +54,8 @@ function MarketTA2(props: IMarketTA2Props): React.ReactElement { Market-TA.II
- If you sell at {numeralWrapper.formatMoney(sCost)}, then you will sell{" "} - {numeralWrapper.format(markup, "0.00000")}x as much compared to if you sold at market price. + If you sell at {formatMoney(sCost)}, then you will sell x{formatPreciseMultiplier(markup)} as much compared to + if you sold at market price.
@@ -103,9 +103,8 @@ export function MaterialMarketTaModal(props: IProps): React.ReactElement { <> Market-TA.I - The maximum sale price you can mark this up to is {numeralWrapper.formatMoney(props.mat.bCost + markupLimit)}. - This means that if you set the sale price higher than this, you will begin to experience a loss in number of - sales + The maximum sale price you can mark this up to is {formatMoney(props.mat.bCost + markupLimit)}. This means + that if you set the sale price higher than this, you will begin to experience a loss in number of sales Market-TA.II
- If you sell at {numeralWrapper.formatMoney(sCost)}, then you will sell{" "} - {numeralWrapper.format(markup, "0.00000")}x as much compared to if you sold at market price. + If you sell at {formatMoney(sCost)}, then you will sell x{formatPreciseMultiplier(markup)} as much compared to + if you sold at market price.
@@ -94,9 +94,8 @@ export function ProductMarketTaModal(props: IProps): React.ReactElement { <> Market-TA.I - The maximum sale price you can mark this up to is{" "} - {numeralWrapper.formatMoney(props.product.pCost + markupLimit)}. This means that if you set the sale price - higher than this, you will begin to experience a loss in number of sales + The maximum sale price you can mark this up to is {formatMoney(props.product.pCost + markupLimit)}. This means + that if you set the sale price higher than this, you will begin to experience a loss in number of sales - Purchasing {numeralWrapper.format(parsedAmt, "0,0.00")} of {props.mat.name} will cost{" "} - {numeralWrapper.formatMoney(cost)} + Purchasing {formatMatPurchaseAmount(parsedAmt)} of {props.mat.name} will cost {formatMoney(cost)} ); diff --git a/src/Corporation/ui/modals/SellSharesModal.tsx b/src/Corporation/ui/modals/SellSharesModal.tsx index f034c47f1..f5cacce77 100644 --- a/src/Corporation/ui/modals/SellSharesModal.tsx +++ b/src/Corporation/ui/modals/SellSharesModal.tsx @@ -1,5 +1,5 @@ import React, { useState } from "react"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney } from "../../../ui/formatNumber"; import { dialogBoxCreate } from "../../../ui/React/DialogBox"; import { Modal } from "../../../ui/React/Modal"; import { useCorporation } from "../Context"; @@ -34,7 +34,7 @@ export function SellSharesModal(props: IProps): React.ReactElement { } else { const stockSaleResults = corp.calculateShareSale(props.shares); const profit = stockSaleResults[0]; - text = `Sell ${props.shares} shares for a total of ${numeralWrapper.formatMoney(profit)}`; + text = `Sell ${props.shares} shares for a total of ${formatMoney(profit)}`; } return ( @@ -51,7 +51,7 @@ export function SellSharesModal(props: IProps): React.ReactElement { props.onClose(); dialogBoxCreate( <> - Sold {numeralWrapper.formatMoney(shares)} shares for + Sold {formatMoney(shares)} shares for . The corporation's stock price fell to  as a result of dilution. , @@ -78,7 +78,7 @@ export function SellSharesModal(props: IProps): React.ReactElement { large number of shares all at once will have an immediate effect in reducing your stock price.

- The current price of your company's stock is {numeralWrapper.formatMoney(corp.sharePrice)} + The current price of your company's stock is {formatMoney(corp.sharePrice)}
0) { dialogBoxCreate( "You threw a party for the office! The morale and happiness of each employee increased by " + - numeralWrapper.formatPercentage(increase) + + formatPercent(increase) + " and was multiplied by " + - numeralWrapper.formatMultiplier(mult), + formatMultiplier(mult), ); } diff --git a/src/Corporation/ui/modals/UpgradeOfficeSizeModal.tsx b/src/Corporation/ui/modals/UpgradeOfficeSizeModal.tsx index 080d59de9..7e08e710c 100644 --- a/src/Corporation/ui/modals/UpgradeOfficeSizeModal.tsx +++ b/src/Corporation/ui/modals/UpgradeOfficeSizeModal.tsx @@ -1,5 +1,5 @@ import React from "react"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatMoney } from "../../../ui/formatNumber"; import * as corpConstants from "../../data/Constants"; import { OfficeSpace } from "../../OfficeSpace"; import { Corporation } from "../../Corporation"; @@ -32,7 +32,7 @@ function UpgradeSizeButton(props: IUpgradeButton): React.ReactElement { props.onClose(); } return ( - + diff --git a/src/Gang/ui/EquipmentsSubpage.tsx b/src/Gang/ui/EquipmentsSubpage.tsx index ef38a026b..234017036 100644 --- a/src/Gang/ui/EquipmentsSubpage.tsx +++ b/src/Gang/ui/EquipmentsSubpage.tsx @@ -10,7 +10,7 @@ import Select, { SelectChangeEvent } from "@mui/material/Select"; import { MenuItem, Table, TableBody, TextField } from "@mui/material"; import SearchIcon from "@mui/icons-material/Search"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatMultiplier, formatPercent } from "../../ui/formatNumber"; import { GangMemberUpgrades } from "../GangMemberUpgrades"; import { GangMemberUpgrade } from "../GangMemberUpgrade"; import { Money } from "../../ui/React/Money"; @@ -142,29 +142,23 @@ function GangMemberUpgradePanel(props: IPanelProps): React.ReactElement { - Hk: x{numeralWrapper.formatMultiplier(props.member.hack_mult * asc.hack)}(x - {numeralWrapper.formatMultiplier(props.member.hack_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.hack)} Asc) + Hk: x{formatMultiplier(props.member.hack_mult * asc.hack)}(x + {formatMultiplier(props.member.hack_mult)} Eq, x{formatMultiplier(asc.hack)} Asc)
- St: x{numeralWrapper.formatMultiplier(props.member.str_mult * asc.str)} - (x{numeralWrapper.formatMultiplier(props.member.str_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.str)} Asc) + St: x{formatMultiplier(props.member.str_mult * asc.str)} + (x{formatMultiplier(props.member.str_mult)} Eq, x{formatMultiplier(asc.str)} Asc)
- Df: x{numeralWrapper.formatMultiplier(props.member.def_mult * asc.def)} - (x{numeralWrapper.formatMultiplier(props.member.def_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.def)} Asc) + Df: x{formatMultiplier(props.member.def_mult * asc.def)} + (x{formatMultiplier(props.member.def_mult)} Eq, x{formatMultiplier(asc.def)} Asc)
- Dx: x{numeralWrapper.formatMultiplier(props.member.dex_mult * asc.dex)} - (x{numeralWrapper.formatMultiplier(props.member.dex_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.dex)} Asc) + Dx: x{formatMultiplier(props.member.dex_mult * asc.dex)} + (x{formatMultiplier(props.member.dex_mult)} Eq, x{formatMultiplier(asc.dex)} Asc)
- Ag: x{numeralWrapper.formatMultiplier(props.member.agi_mult * asc.agi)} - (x{numeralWrapper.formatMultiplier(props.member.agi_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.agi)} Asc) + Ag: x{formatMultiplier(props.member.agi_mult * asc.agi)} + (x{formatMultiplier(props.member.agi_mult)} Eq, x{formatMultiplier(asc.agi)} Asc)
- Ch: x{numeralWrapper.formatMultiplier(props.member.cha_mult * asc.cha)} - (x{numeralWrapper.formatMultiplier(props.member.cha_mult)} Eq, x - {numeralWrapper.formatMultiplier(asc.cha)} Asc) + Ch: x{formatMultiplier(props.member.cha_mult * asc.cha)} + (x{formatMultiplier(props.member.cha_mult)} Eq, x{formatMultiplier(asc.cha)} Asc) } > @@ -262,7 +256,7 @@ export function EquipmentsSubpage(): React.ReactElement { } > - Discount: -{numeralWrapper.formatPercentage(1 - 1 / gang.getDiscount())} + Discount: -{formatPercent(1 - 1 / gang.getDiscount())} ], - [`Respect:`, `${numeralWrapper.formatRespect(5 * props.member.calculateRespectGain(gang))} / sec`], - [`Wanted Level:`, `${numeralWrapper.formatWanted(5 * props.member.calculateWantedLevelGain(gang))} / sec`], - [`Total Respect:`, `${numeralWrapper.formatRespect(props.member.earnedRespect)}`], + [`Respect:`, `${formatRespect(5 * props.member.calculateRespectGain(gang))} / sec`], + [`Wanted Level:`, `${formatWanted(5 * props.member.calculateWantedLevelGain(gang))} / sec`], + [`Total Respect:`, `${formatRespect(props.member.earnedRespect)}`], ]; return ( @@ -45,29 +45,23 @@ export function GangMemberStats(props: IProps): React.ReactElement { - Hk: x{numeralWrapper.formatMultiplier(props.member.hack_mult * asc.hack)}(x - {numeralWrapper.formatMultiplier(props.member.hack_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.hack)}{" "} - Asc) + Hk: x{formatMultiplier(props.member.hack_mult * asc.hack)}(x + {formatMultiplier(props.member.hack_mult)} Eq, x{formatMultiplier(asc.hack)} Asc)
- St: x{numeralWrapper.formatMultiplier(props.member.str_mult * asc.str)} - (x{numeralWrapper.formatMultiplier(props.member.str_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.str)}{" "} - Asc) + St: x{formatMultiplier(props.member.str_mult * asc.str)} + (x{formatMultiplier(props.member.str_mult)} Eq, x{formatMultiplier(asc.str)} Asc)
- Df: x{numeralWrapper.formatMultiplier(props.member.def_mult * asc.def)} - (x{numeralWrapper.formatMultiplier(props.member.def_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.def)}{" "} - Asc) + Df: x{formatMultiplier(props.member.def_mult * asc.def)} + (x{formatMultiplier(props.member.def_mult)} Eq, x{formatMultiplier(asc.def)} Asc)
- Dx: x{numeralWrapper.formatMultiplier(props.member.dex_mult * asc.dex)} - (x{numeralWrapper.formatMultiplier(props.member.dex_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.dex)}{" "} - Asc) + Dx: x{formatMultiplier(props.member.dex_mult * asc.dex)} + (x{formatMultiplier(props.member.dex_mult)} Eq, x{formatMultiplier(asc.dex)} Asc)
- Ag: x{numeralWrapper.formatMultiplier(props.member.agi_mult * asc.agi)} - (x{numeralWrapper.formatMultiplier(props.member.agi_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.agi)}{" "} - Asc) + Ag: x{formatMultiplier(props.member.agi_mult * asc.agi)} + (x{formatMultiplier(props.member.agi_mult)} Eq, x{formatMultiplier(asc.agi)} Asc)
- Ch: x{numeralWrapper.formatMultiplier(props.member.cha_mult * asc.cha)} - (x{numeralWrapper.formatMultiplier(props.member.cha_mult)} Eq, x{numeralWrapper.formatMultiplier(asc.cha)}{" "} - Asc) + Ch: x{formatMultiplier(props.member.cha_mult * asc.cha)} + (x{formatMultiplier(props.member.cha_mult)} Eq, x{formatMultiplier(asc.cha)} Asc) } > diff --git a/src/Gang/ui/GangStats.tsx b/src/Gang/ui/GangStats.tsx index ec07fd858..f2cbd1cee 100644 --- a/src/Gang/ui/GangStats.tsx +++ b/src/Gang/ui/GangStats.tsx @@ -5,8 +5,7 @@ import React from "react"; import { Factions } from "../../Faction/Factions"; -import { formatNumber } from "../../utils/StringHelperFunctions"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatNumberNoSuffix, formatRespect, formatWanted } from "../../ui/formatNumber"; import { MoneyRate } from "../../ui/React/MoneyRate"; import { Reputation } from "../../ui/React/Reputation"; import { AllGangs } from "../AllGangs"; @@ -21,11 +20,11 @@ export function GangStats(): React.ReactElement { const territoryMult = AllGangs[gang.facName].territory * 100; let territoryStr; if (territoryMult <= 0) { - territoryStr = formatNumber(0, 2); + territoryStr = formatNumberNoSuffix(0, 2); } else if (territoryMult >= 100) { - territoryStr = formatNumber(100, 2); + territoryStr = formatNumberNoSuffix(100, 2); } else { - territoryStr = formatNumber(territoryMult, 2); + territoryStr = formatNumberNoSuffix(territoryMult, 2); } return ( @@ -41,8 +40,7 @@ export function GangStats(): React.ReactElement { } > - Respect: {numeralWrapper.formatRespect(gang.respect)} ( - {numeralWrapper.formatRespect(5 * gang.respectGainRate)} / sec) + Respect: {formatRespect(gang.respect)} ({formatRespect(5 * gang.respectGainRate)} / sec) @@ -57,15 +55,16 @@ export function GangStats(): React.ReactElement { } > - Wanted Level: {numeralWrapper.formatWanted(gang.wanted)} ( - {numeralWrapper.formatWanted(5 * gang.wantedGainRate)} / sec) + Wanted Level: {formatWanted(gang.wanted)} ({formatWanted(5 * gang.wantedGainRate)} / sec) Penalty for respect and money gain rates due to Wanted Level}> - Wanted Level Penalty: -{formatNumber((1 - gang.getWantedPenalty()) * 100, 2)}% + + Wanted Level Penalty: -{formatNumberNoSuffix((1 - gang.getWantedPenalty()) * 100, 2)}% + diff --git a/src/Gang/ui/RecruitButton.tsx b/src/Gang/ui/RecruitButton.tsx index 8fe5d9094..ddf7b69e0 100644 --- a/src/Gang/ui/RecruitButton.tsx +++ b/src/Gang/ui/RecruitButton.tsx @@ -1,7 +1,7 @@ import React, { useState } from "react"; import { RecruitModal } from "./RecruitModal"; import { GangConstants } from "../data/Constants"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRespect } from "../../ui/formatNumber"; import { useGang } from "./Context"; import Typography from "@mui/material/Typography"; import Button from "@mui/material/Button"; @@ -24,9 +24,7 @@ export function RecruitButton(props: IProps): React.ReactElement { return ( - - {numeralWrapper.formatRespect(respect)} respect needed to recruit next member - + {formatRespect(respect)} respect needed to recruit next member ); } diff --git a/src/Gang/ui/TerritorySubpage.tsx b/src/Gang/ui/TerritorySubpage.tsx index 6dccb8778..5715c35b9 100644 --- a/src/Gang/ui/TerritorySubpage.tsx +++ b/src/Gang/ui/TerritorySubpage.tsx @@ -3,8 +3,7 @@ import React, { useState } from "react"; import { Container, Button, Paper, Box, Tooltip, Switch, FormControlLabel, Typography } from "@mui/material"; import { Help } from "@mui/icons-material"; -import { numeralWrapper } from "../../ui/numeralFormat"; -import { formatNumber } from "../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix, formatPercent } from "../../ui/formatNumber"; import { AllGangs } from "../AllGangs"; @@ -77,8 +76,8 @@ export function TerritorySubpage(): React.ReactElement { /> - Territory Clash Chance: {numeralWrapper.formatPercentage(gang.territoryClashChance, 3)}
- Power: {formatNumber(AllGangs[gang.facName].power, 3)}
+ Territory Clash Chance: {formatPercent(gang.territoryClashChance, 3)}
+ Power: {formatNumberNoSuffix(AllGangs[gang.facName].power, 3)}
Territory: {formatTerritory(AllGangs[gang.facName].territory)}%
@@ -101,11 +100,11 @@ function formatTerritory(n: number): string { const v = n * 100; const precision = 3; if (v <= 0) { - return formatNumber(0, precision); + return formatNumberNoSuffix(0, precision); } else if (v >= 100) { - return formatNumber(100, precision); + return formatNumberNoSuffix(100, precision); } else { - return formatNumber(v, precision); + return formatNumberNoSuffix(v, precision); } } @@ -126,9 +125,9 @@ function OtherGangTerritory(props: ITerritoryProps): React.ReactElement { {props.name} - Power: {formatNumber(power, 3)}
+ Power: {formatNumberNoSuffix(power, 3)}
Territory: {formatTerritory(territory)}%
- Clash Win Chance: {numeralWrapper.formatPercentage(clashVictoryChance, 3)} + Clash Win Chance: {formatPercent(clashVictoryChance, 3)} ); diff --git a/src/Hacknet/data/HashUpgradesMetadata.tsx b/src/Hacknet/data/HashUpgradesMetadata.tsx index 0864c458c..9c49311ed 100644 --- a/src/Hacknet/data/HashUpgradesMetadata.tsx +++ b/src/Hacknet/data/HashUpgradesMetadata.tsx @@ -1,7 +1,7 @@ // Metadata used to construct all Hash Upgrades import React from "react"; import { IConstructorParams } from "../HashUpgrade"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatInt } from "../../ui/formatNumber"; import { Money } from "../../ui/React/Money"; export const HashUpgradesMetadata: IConstructorParams[] = [ @@ -72,7 +72,7 @@ export const HashUpgradesMetadata: IConstructorParams[] = [ desc: "Exchange hashes for 1k Scientific Research in all of your Corporation's Industries", name: "Exchange for Corporation Research", effectText: (level: number): JSX.Element | null => ( - <>Acquired a total of {level}k Scientific Research in your industries. + <>Acquired a total of {formatInt(level * 1000)} Scientific Research in your industries. ), value: 1000, }, @@ -81,7 +81,7 @@ export const HashUpgradesMetadata: IConstructorParams[] = [ desc: "Exchange hashes for 100 Bladeburner Rank", name: "Exchange for Bladeburner Rank", effectText: (level: number): JSX.Element | null => ( - <>Acquired a total of {numeralWrapper.format(100 * level, "0a")} Bladeburner rank + <>Acquired a total of {formatInt(100 * level)} Bladeburner rank ), value: 100, }, @@ -90,7 +90,7 @@ export const HashUpgradesMetadata: IConstructorParams[] = [ desc: "Exchanges hashes for 10 Bladeburner Skill Points", name: "Exchange for Bladeburner SP", effectText: (level: number): JSX.Element | null => ( - <>Acquired a total of {numeralWrapper.format(10 * level, "0a")} Bladeburner Skill Points + <>Acquired a total of {formatInt(10 * level)} Bladeburner Skill Points ), value: 10, }, diff --git a/src/Hacknet/ui/HacknetNodeElem.tsx b/src/Hacknet/ui/HacknetNodeElem.tsx index 91a68270d..1ea5add5c 100644 --- a/src/Hacknet/ui/HacknetNodeElem.tsx +++ b/src/Hacknet/ui/HacknetNodeElem.tsx @@ -29,7 +29,7 @@ import TableBody from "@mui/material/TableBody"; import Table from "@mui/material/Table"; import TableRow from "@mui/material/TableRow"; import Tooltip from "@mui/material/Tooltip"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { calculateMoneyGainRate } from "../formulas/HacknetNodes"; interface IProps { @@ -196,7 +196,7 @@ export function HacknetNodeElem(props: IProps): React.ReactElement { RAM: - {numeralWrapper.formatRAM(node.ram)} + {formatRam(node.ram)} {upgradeRAMButton} diff --git a/src/Hacknet/ui/HacknetServerElem.tsx b/src/Hacknet/ui/HacknetServerElem.tsx index c31178966..6e608e95e 100644 --- a/src/Hacknet/ui/HacknetServerElem.tsx +++ b/src/Hacknet/ui/HacknetServerElem.tsx @@ -31,7 +31,7 @@ import { TableCell } from "../../ui/React/Table"; import TableBody from "@mui/material/TableBody"; import Table from "@mui/material/Table"; import TableRow from "@mui/material/TableRow"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { calculateHashGainRate } from "../formulas/HacknetServers"; import Tooltip from "@mui/material/Tooltip"; @@ -273,10 +273,10 @@ export function HacknetServerElem(props: IProps): React.ReactElement { {" "} max production rate. (achieved when 100% RAM is allocated to it)
- {numeralWrapper.formatRAM(node.ramUsed)} / {numeralWrapper.formatRAM(node.maxRam)} ( + {formatRam(node.ramUsed)} / {formatRam(node.maxRam)} ( {Math.round((100 * node.ramUsed) / node.maxRam)}%) RAM allocated to script.
- {numeralWrapper.formatRAM(node.maxRam - node.ramUsed)} / {numeralWrapper.formatRAM(node.maxRam)} ( + {formatRam(node.maxRam - node.ramUsed)} / {formatRam(node.maxRam)} ( {Math.round((100 * (node.maxRam - node.ramUsed)) / node.maxRam)}%) RAM allocated to hash production. } @@ -311,7 +311,7 @@ export function HacknetServerElem(props: IProps): React.ReactElement { RAM: - {numeralWrapper.formatRAM(node.maxRam)} + {formatRam(node.maxRam)} {upgradeRamButton} diff --git a/src/Infiltration/ui/Intro.tsx b/src/Infiltration/ui/Intro.tsx index 7844ba3ca..aab3843d3 100644 --- a/src/Infiltration/ui/Intro.tsx +++ b/src/Infiltration/ui/Intro.tsx @@ -3,7 +3,7 @@ import { Box, Button, Container, Paper, Tooltip, Typography } from "@mui/materia import React from "react"; import { Location } from "../../Locations/Location"; import { Settings } from "../../Settings/Settings"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatNumberNoSuffix } from "../../ui/formatNumber"; interface IProps { Location: Location; @@ -74,7 +74,7 @@ export function Intro(props: IProps): React.ReactElement { }} > Difficulty:  - {numeralWrapper.format(props.Difficulty * 33.3333, "0")} / 100 + {formatNumberNoSuffix(props.Difficulty * 33.3333)} / 100 {props.Difficulty > 1.5 && ( - have gained {formatNumber(infiltrationRepGain, 2)} rep for {FactionNames.ShadowsOfAnarchy} and{" "} + have gained {formatNumberNoSuffix(infiltrationRepGain, 2)} rep for {FactionNames.ShadowsOfAnarchy} and{" "} ) : ( <> diff --git a/src/Locations/ui/PurchaseServerModal.tsx b/src/Locations/ui/PurchaseServerModal.tsx index 711e1d753..86e273b2f 100644 --- a/src/Locations/ui/PurchaseServerModal.tsx +++ b/src/Locations/ui/PurchaseServerModal.tsx @@ -1,6 +1,6 @@ import React, { useState } from "react"; import { purchaseServer } from "../../Server/ServerPurchases"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { Money } from "../../ui/React/Money"; import { Modal } from "../../ui/React/Modal"; import { Player } from "@player"; @@ -37,7 +37,7 @@ export function PurchaseServerModal(props: IProps): React.ReactElement { return ( - Would you like to purchase a new server with {numeralWrapper.formatRAM(props.ram)} of RAM for{" "} + Would you like to purchase a new server with {formatRam(props.ram)} of RAM for{" "} ?
diff --git a/src/Locations/ui/RamButton.tsx b/src/Locations/ui/RamButton.tsx index ab66f44fd..daedd902f 100644 --- a/src/Locations/ui/RamButton.tsx +++ b/src/Locations/ui/RamButton.tsx @@ -8,7 +8,7 @@ import { Player } from "@player"; import { purchaseRamForHomeComputer } from "../../Server/ServerPurchases"; import { Money } from "../../ui/React/Money"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { MathJax } from "better-react-mathjax"; import { BitNodeMultipliers } from "../../BitNode/BitNodeMultipliers"; @@ -45,8 +45,8 @@ export function RamButton(props: IProps): React.ReactElement {
diff --git a/src/Locations/ui/SlumsLocation.tsx b/src/Locations/ui/SlumsLocation.tsx index f34e8d9b5..dab0cb369 100644 --- a/src/Locations/ui/SlumsLocation.tsx +++ b/src/Locations/ui/SlumsLocation.tsx @@ -9,7 +9,7 @@ import Tooltip from "@mui/material/Tooltip"; import { Crimes } from "../../Crime/Crimes"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatPercent } from "../../ui/formatNumber"; import { Router } from "../../ui/GameRoot"; import { Page } from "../../ui/Router"; import { Player } from "@player"; @@ -37,7 +37,7 @@ export function SlumsLocation(): React.ReactElement { {crimes.map((crime) => ( ))} diff --git a/src/Locations/ui/TechVendorLocation.tsx b/src/Locations/ui/TechVendorLocation.tsx index 98fc77cd7..fef6a3274 100644 --- a/src/Locations/ui/TechVendorLocation.tsx +++ b/src/Locations/ui/TechVendorLocation.tsx @@ -17,7 +17,7 @@ import { getPurchaseServerCost } from "../../Server/ServerPurchases"; import { Money } from "../../ui/React/Money"; import { Player } from "@player"; import { PurchaseServerModal } from "./PurchaseServerModal"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { Box } from "@mui/material"; interface IServerProps { @@ -31,7 +31,7 @@ function ServerButton(props: IServerProps): React.ReactElement { return ( <> unknown; /** Type for internal, unwrapped ctx function that produces an APIFunction */ type InternalFn = (ctx: NetscriptContext) => ((...args: unknown[]) => ReturnType) & F; /** Type constraint for an API layer. They must all fit this "shape". */ -type GenericAPI = { [key: string]: APIFn | GenericAPI }; +type GenericAPI = { [key in keyof T]: APIFn | GenericAPI }; // args, enums, and pid are excluded from the API for typing purposes via the definition of NSFull. // They do in fact exist on the external API (but are absent on the internal API and ramcost tree) @@ -21,7 +21,7 @@ export type NetscriptContext = { functionPath: string; }; -class NSProxyHandler { +class NSProxyHandler> { ns: API; ws: WorkerScript; tree: string[]; @@ -81,17 +81,18 @@ class NSProxyHandler { return ((this.memoed[key] as APIFn) = wrappedFunction); } if (typeof field === "object") { - return ((this.memoed[key] as GenericAPI) = NSProxy(this.ws, field as InternalAPI, [ - ...this.tree, - key, - ])); + return ((this.memoed[key] as GenericAPI) = NSProxy( + this.ws, + field as InternalAPI>, + [...this.tree, key], + )); } console.warn(`Unexpected data while wrapping API.`, "tree:", this.tree, "key:", key, "field:", field); throw new Error("Error while wrapping netscript API. See console."); } } -export function NSProxy( +export function NSProxy>( ws: WorkerScript, ns: InternalAPI, tree: string[], diff --git a/src/Netscript/NetscriptHelpers.ts b/src/Netscript/NetscriptHelpers.ts index 6bc8069d1..174db3e59 100644 --- a/src/Netscript/NetscriptHelpers.ts +++ b/src/Netscript/NetscriptHelpers.ts @@ -3,7 +3,7 @@ import { WorkerScript } from "./WorkerScript"; import { GetAllServers, GetServer } from "../Server/AllServers"; import { Player } from "@player"; import { ScriptDeath } from "./ScriptDeath"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatExp, formatMoney, formatRam, formatThreads } from "../ui/formatNumber"; import { ScriptArg } from "./ScriptArg"; import { CityName } from "../Enums"; import { BasicHGWOptions, RunningScript as IRunningScript, Person as IPerson } from "@nsdefs"; @@ -354,8 +354,8 @@ function updateDynamicRam(ctx: NetscriptContext, ramCost: number): void { This is probably because you somehow circumvented the static RAM calculation. Threads: ${threads} - Dynamic RAM Usage: ${numeralWrapper.formatRAM(ws.dynamicRamUsage)} per thread - Static RAM Usage: ${numeralWrapper.formatRAM(ws.ramUsage)} per thread + Dynamic RAM Usage: ${formatRam(ws.dynamicRamUsage)} per thread + Static RAM Usage: ${formatRam(ws.ramUsage)} per thread One of these could be the reason: * Using eval() to get a reference to a ns function @@ -448,7 +448,7 @@ function hack( `Executing on '${server.hostname}' in ${convertTimeMsToTimeElapsedString( hackingTime * 1000, true, - )} (t=${numeralWrapper.formatThreads(threads)})`, + )} (t=${formatThreads(threads)})`, ); return helpers.netscriptDelay(ctx, hackingTime * 1000).then(function () { @@ -495,9 +495,9 @@ function hack( log( ctx, () => - `Successfully hacked '${server.hostname}' for ${numeralWrapper.formatMoney( - moneyGained, - )} and ${numeralWrapper.formatExp(expGainedOnSuccess)} exp (t=${numeralWrapper.formatThreads(threads)})`, + `Successfully hacked '${server.hostname}' for ${formatMoney(moneyGained)} and ${formatExp( + expGainedOnSuccess, + )} exp (t=${formatThreads(threads)})`, ); server.fortify(CONSTANTS.ServerFortifyAmount * Math.min(threads, maxThreadNeeded)); if (stock) { @@ -514,9 +514,9 @@ function hack( log( ctx, () => - `Failed to hack '${server.hostname}'. Gained ${numeralWrapper.formatExp( - expGainedOnFailure, - )} exp (t=${numeralWrapper.formatThreads(threads)})`, + `Failed to hack '${server.hostname}'. Gained ${formatExp(expGainedOnFailure)} exp (t=${formatThreads( + threads, + )})`, ); return 0; } diff --git a/src/Netscript/RamCostGenerator.ts b/src/Netscript/RamCostGenerator.ts index 1512b151c..ae9b32ec9 100644 --- a/src/Netscript/RamCostGenerator.ts +++ b/src/Netscript/RamCostGenerator.ts @@ -518,6 +518,9 @@ export const RamCosts: RamCostTree = { getTotalScriptExpGain: RamCostConstants.GetScript, getScriptExpGain: RamCostConstants.GetScript, getRunningScript: RamCostConstants.GetRunningScript, + formatNumber: 0, + formatRam: 0, + formatPercent: 0, nFormat: 0, tFormat: 0, getTimeSinceLastAug: RamCostConstants.GetHackTime, diff --git a/src/NetscriptFunctions.ts b/src/NetscriptFunctions.ts index 02f9ee521..3aa6f90a6 100644 --- a/src/NetscriptFunctions.ts +++ b/src/NetscriptFunctions.ts @@ -43,8 +43,17 @@ import { killWorkerScript } from "./Netscript/killWorkerScript"; import { workerScripts } from "./Netscript/WorkerScripts"; import { WorkerScript } from "./Netscript/WorkerScript"; import { helpers, assertObjectType } from "./Netscript/NetscriptHelpers"; -import { numeralWrapper } from "./ui/numeralFormat"; -import { convertTimeMsToTimeElapsedString, formatNumber } from "./utils/StringHelperFunctions"; +import { + formatExp, + formatNumberNoSuffix, + formatMoney, + formatPercent, + formatRam, + formatSecurity, + formatThreads, + formatNumber, +} from "./ui/formatNumber"; +import { convertTimeMsToTimeElapsedString } from "./utils/StringHelperFunctions"; import { LogBoxEvents, LogBoxCloserEvents, LogBoxPositionEvents, LogBoxSizeEvents } from "./ui/React/LogBoxManager"; import { arrayToString } from "./utils/helpers/arrayToString"; import { isString } from "./utils/helpers/isString"; @@ -80,6 +89,7 @@ import { assert, arrayAssert, stringAssert, objectAssert } from "./utils/helpers import { CityName, JobName, CrimeType, GymType, LocationName, UniversityClassType } from "./Enums"; import { cloneDeep } from "lodash"; import { FactionWorkType } from "./Enums"; +import numeral from "numeral"; export const enums: NSEnums = { CityName, @@ -261,7 +271,7 @@ export const ns: InternalAPI = { `Executing on '${server.hostname}' in ${convertTimeMsToTimeElapsedString( growTime * 1000, true, - )} (t=${numeralWrapper.formatThreads(threads)}).`, + )} (t=${formatThreads(threads)}).`, ); return helpers.netscriptDelay(ctx, growTime * 1000).then(function () { const moneyBefore = server.moneyAvailable <= 0 ? 1 : server.moneyAvailable; @@ -273,10 +283,9 @@ export const ns: InternalAPI = { helpers.log( ctx, () => - `Available money on '${server.hostname}' grown by ${numeralWrapper.formatPercentage( - logGrowPercent, - 6, - )}. Gained ${numeralWrapper.formatExp(expGain)} hacking exp (t=${numeralWrapper.formatThreads(threads)}).`, + `Available money on '${server.hostname}' grown by ${formatPercent(logGrowPercent, 6)}. Gained ${formatExp( + expGain, + )} hacking exp (t=${formatThreads(threads)}).`, ); ctx.workerScript.scriptRef.onlineExpGained += expGain; Player.gainHackingExp(expGain); @@ -359,7 +368,7 @@ export const ns: InternalAPI = { `Executing on '${server.hostname}' in ${convertTimeMsToTimeElapsedString( weakenTime * 1000, true, - )} (t=${numeralWrapper.formatThreads(threads)})`, + )} (t=${formatThreads(threads)})`, ); return helpers.netscriptDelay(ctx, weakenTime * 1000).then(function () { const host = GetServer(ctx.workerScript.hostname); @@ -374,9 +383,9 @@ export const ns: InternalAPI = { helpers.log( ctx, () => - `'${server.hostname}' security level weakened to ${ - server.hackDifficulty - }. Gained ${numeralWrapper.formatExp(expGain)} hacking exp (t=${numeralWrapper.formatThreads(threads)})`, + `'${server.hostname}' security level weakened to ${server.hackDifficulty}. Gained ${formatExp( + expGain, + )} hacking exp (t=${formatThreads(threads)})`, ); ctx.workerScript.scriptRef.onlineExpGained += expGain; Player.gainHackingExp(expGain); @@ -1070,10 +1079,10 @@ export const ns: InternalAPI = { } if (server.hostname == "home") { // Return player's money - helpers.log(ctx, () => `returned player's money: ${numeralWrapper.formatMoney(Player.money)}`); + helpers.log(ctx, () => `returned player's money: ${formatMoney(Player.money)}`); return Player.money; } - helpers.log(ctx, () => `returned ${numeralWrapper.formatMoney(server.moneyAvailable)} for '${server.hostname}'`); + helpers.log(ctx, () => `returned ${formatMoney(server.moneyAvailable)} for '${server.hostname}'`); return server.moneyAvailable; }, getServerSecurityLevel: (ctx) => (_hostname) => { @@ -1086,10 +1095,7 @@ export const ns: InternalAPI = { if (helpers.failOnHacknetServer(ctx, server)) { return 1; } - helpers.log( - ctx, - () => `returned ${numeralWrapper.formatServerSecurity(server.hackDifficulty)} for '${server.hostname}'`, - ); + helpers.log(ctx, () => `returned ${formatSecurity(server.hackDifficulty)} for '${server.hostname}'`); return server.hackDifficulty; }, getServerBaseSecurityLevel: (ctx) => (_hostname) => { @@ -1103,10 +1109,7 @@ export const ns: InternalAPI = { if (helpers.failOnHacknetServer(ctx, server)) { return 1; } - helpers.log( - ctx, - () => `returned ${numeralWrapper.formatServerSecurity(server.baseDifficulty)} for '${server.hostname}'`, - ); + helpers.log(ctx, () => `returned ${formatSecurity(server.baseDifficulty)} for '${server.hostname}'`); return server.baseDifficulty; }, getServerMinSecurityLevel: (ctx) => (_hostname) => { @@ -1119,10 +1122,7 @@ export const ns: InternalAPI = { if (helpers.failOnHacknetServer(ctx, server)) { return 1; } - helpers.log( - ctx, - () => `returned ${numeralWrapper.formatServerSecurity(server.minDifficulty)} for ${server.hostname}`, - ); + helpers.log(ctx, () => `returned ${formatSecurity(server.minDifficulty)} for ${server.hostname}`); return server.minDifficulty; }, getServerRequiredHackingLevel: (ctx) => (_hostname) => { @@ -1135,7 +1135,7 @@ export const ns: InternalAPI = { if (helpers.failOnHacknetServer(ctx, server)) { return 1; } - helpers.log(ctx, () => `returned ${formatNumber(server.requiredHackingSkill, 0)} for '${server.hostname}'`); + helpers.log(ctx, () => `returned ${formatNumberNoSuffix(server.requiredHackingSkill, 0)} for '${server.hostname}'`); return server.requiredHackingSkill; }, getServerMaxMoney: (ctx) => (_hostname) => { @@ -1148,7 +1148,7 @@ export const ns: InternalAPI = { if (helpers.failOnHacknetServer(ctx, server)) { return 0; } - helpers.log(ctx, () => `returned ${numeralWrapper.formatMoney(server.moneyMax)} for '${server.hostname}'`); + helpers.log(ctx, () => `returned ${formatMoney(server.moneyMax)} for '${server.hostname}'`); return server.moneyMax; }, getServerGrowth: (ctx) => (_hostname) => { @@ -1180,13 +1180,13 @@ export const ns: InternalAPI = { getServerMaxRam: (ctx) => (_hostname) => { const hostname = helpers.string(ctx, "hostname", _hostname); const server = helpers.getServer(ctx, hostname); - helpers.log(ctx, () => `returned ${numeralWrapper.formatRAM(server.maxRam)}`); + helpers.log(ctx, () => `returned ${formatRam(server.maxRam)}`); return server.maxRam; }, getServerUsedRam: (ctx) => (_hostname) => { const hostname = helpers.string(ctx, "hostname", _hostname); const server = helpers.getServer(ctx, hostname); - helpers.log(ctx, () => `returned ${numeralWrapper.formatRAM(server.ramUsed)}`); + helpers.log(ctx, () => `returned ${formatRam(server.ramUsed)}`); return server.ramUsed; }, serverExists: (ctx) => (_hostname) => { @@ -1273,7 +1273,7 @@ export const ns: InternalAPI = { } if (Player.money < cost) { - helpers.log(ctx, () => `Not enough money to purchase server. Need ${numeralWrapper.formatMoney(cost)}`); + helpers.log(ctx, () => `Not enough money to purchase server. Need ${formatMoney(cost)}`); return ""; } const newServ = safelyCreateUniqueServer({ @@ -1292,10 +1292,7 @@ export const ns: InternalAPI = { homeComputer.serversOnNetwork.push(newServ.hostname); newServ.serversOnNetwork.push(homeComputer.hostname); Player.loseMoney(cost, "servers"); - helpers.log( - ctx, - () => `Purchased new server with hostname '${newServ.hostname}' for ${numeralWrapper.formatMoney(cost)}`, - ); + helpers.log(ctx, () => `Purchased new server with hostname '${newServ.hostname}' for ${formatMoney(cost)}`); return newServ.hostname; }, @@ -1685,14 +1682,33 @@ export const ns: InternalAPI = { } return runningScript.onlineExpGained / runningScript.onlineRunningTime; }, + formatNumber: + (ctx) => + (_n, _fractionalDigits = 3, _suffixStart = 1000, isInteger) => { + const n = helpers.number(ctx, "n", _n); + const fractionalDigits = helpers.number(ctx, "fractionalDigits", _fractionalDigits); + const suffixStart = helpers.number(ctx, "suffixStart", _suffixStart); + return formatNumber(n, fractionalDigits, suffixStart, !!isInteger); + }, + formatRam: + (ctx) => + (_n, _fractionalDigits = 2) => { + const n = helpers.number(ctx, "n", _n); + const fractionalDigits = helpers.number(ctx, "fractionalDigits", _fractionalDigits); + return formatRam(n, fractionalDigits); + }, + formatPercent: + (ctx) => + (_n, _fractionalDigits = 2) => { + const n = helpers.number(ctx, "n", _n); + const fractionalDigits = helpers.number(ctx, "fractionalDigits", _fractionalDigits); + return formatPercent(n, fractionalDigits); + }, + // Todo: Remove function in 2.3. Until then it just directly wraps numeral. nFormat: (ctx) => (_n, _format) => { const n = helpers.number(ctx, "n", _n); const format = helpers.string(ctx, "format", _format); - if (isNaN(n)) { - return ""; - } - - return numeralWrapper.format(n, format); + return numeral(n).format(format); }, tFormat: (ctx) => (_milliseconds, _milliPrecision) => { const milliseconds = helpers.number(ctx, "milliseconds", _milliseconds); diff --git a/src/NetscriptFunctions/Singularity.ts b/src/NetscriptFunctions/Singularity.ts index 5f716026f..1601a017f 100644 --- a/src/NetscriptFunctions/Singularity.ts +++ b/src/NetscriptFunctions/Singularity.ts @@ -22,7 +22,7 @@ import { Page } from "../ui/Router"; import { Locations } from "../Locations/Locations"; import { GetServer } from "../Server/AllServers"; import { Programs } from "../Programs/Programs"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatMoney, formatRam, formatReputation } from "../ui/formatNumber"; import { BitNodeMultipliers } from "../BitNode/BitNodeMultipliers"; import { Company } from "../Company/Company"; import { Companies } from "../Company/Companies"; @@ -458,10 +458,7 @@ export function NetscriptSingularity(): InternalAPI { } if (Player.money < item.price) { - helpers.log( - ctx, - () => `Not enough money to purchase '${item.program}'. Need ${numeralWrapper.formatMoney(item.price)}`, - ); + helpers.log(ctx, () => `Not enough money to purchase '${item.program}'. Need ${formatMoney(item.price)}`); return false; } @@ -625,7 +622,7 @@ export function NetscriptSingularity(): InternalAPI { const cost = Player.getUpgradeHomeCoresCost(); if (Player.money < cost) { - helpers.log(ctx, () => `You don't have enough money. Need ${numeralWrapper.formatMoney(cost)}`); + helpers.log(ctx, () => `You don't have enough money. Need ${formatMoney(cost)}`); return false; } @@ -656,7 +653,7 @@ export function NetscriptSingularity(): InternalAPI { const cost = Player.getUpgradeHomeRamCost(); if (Player.money < cost) { - helpers.log(ctx, () => `You don't have enough money. Need ${numeralWrapper.formatMoney(cost)}`); + helpers.log(ctx, () => `You don't have enough money. Need ${formatMoney(cost)}`); return false; } @@ -666,10 +663,7 @@ export function NetscriptSingularity(): InternalAPI { Player.gainIntelligenceExp(CONSTANTS.IntelligenceSingFnBaseExpGain * 2); helpers.log( ctx, - () => - `Purchased additional RAM for home computer! It now has ${numeralWrapper.formatRAM( - homeComputer.maxRam, - )} of RAM.`, + () => `Purchased additional RAM for home computer! It now has ${formatRam(homeComputer.maxRam)} of RAM.`, ); return true; }, @@ -979,10 +973,7 @@ export function NetscriptSingularity(): InternalAPI { return false; } if (Player.money < amt) { - helpers.log( - ctx, - () => `You do not have enough money to donate ${numeralWrapper.formatMoney(amt)} to '${facName}'`, - ); + helpers.log(ctx, () => `You do not have enough money to donate ${formatMoney(amt)} to '${facName}'`); return false; } const repNeededToDonate = Math.floor(CONSTANTS.BaseFavorToDonate * BitNodeMultipliers.RepToDonateToFaction); @@ -997,13 +988,7 @@ export function NetscriptSingularity(): InternalAPI { const repGain = (amt / CONSTANTS.DonateMoneyToRepDivisor) * Player.mults.faction_rep; faction.playerReputation += repGain; Player.loseMoney(amt, "other"); - helpers.log( - ctx, - () => - `${numeralWrapper.formatMoney(amt)} donated to '${facName}' for ${numeralWrapper.formatReputation( - repGain, - )} reputation`, - ); + helpers.log(ctx, () => `${formatMoney(amt)} donated to '${facName}' for ${formatReputation(repGain)} reputation`); return true; }, createProgram: diff --git a/src/PersonObjects/Grafting/ui/GraftingRoot.tsx b/src/PersonObjects/Grafting/ui/GraftingRoot.tsx index fb800d44a..dc03b91db 100644 --- a/src/PersonObjects/Grafting/ui/GraftingRoot.tsx +++ b/src/PersonObjects/Grafting/ui/GraftingRoot.tsx @@ -15,7 +15,8 @@ import { Router } from "../../../ui/GameRoot"; import { Page } from "../../../ui/Router"; import { ConfirmationModal } from "../../../ui/React/ConfirmationModal"; import { Money } from "../../../ui/React/Money"; -import { convertTimeMsToTimeElapsedString, formatNumber } from "../../../utils/StringHelperFunctions"; +import { formatNumberNoSuffix } from "../../../ui/formatNumber"; +import { convertTimeMsToTimeElapsedString } from "../../../utils/StringHelperFunctions"; import { Player } from "@player"; import { GraftableAugmentation } from "../GraftableAugmentation"; import { calculateGraftingTimeWithBonus, getGraftingAvailableAugs } from "../GraftingHelpers"; @@ -223,7 +224,7 @@ export const GraftingRoot = (): React.ReactElement => { Entropy strength: {Player.entropy}
All multipliers decreased by:{" "} - {formatNumber((1 - CONSTANTS.EntropyEffect ** Player.entropy) * 100, 3)}% (multiplicative) + {formatNumberNoSuffix((1 - CONSTANTS.EntropyEffect ** Player.entropy) * 100, 3)}% (multiplicative) diff --git a/src/PersonObjects/Player/PlayerObjectGeneralMethods.ts b/src/PersonObjects/Player/PlayerObjectGeneralMethods.ts index b3da61ad3..9850c15b1 100644 --- a/src/PersonObjects/Player/PlayerObjectGeneralMethods.ts +++ b/src/PersonObjects/Player/PlayerObjectGeneralMethods.ts @@ -34,7 +34,7 @@ import { SourceFiles } from "../../SourceFile/SourceFiles"; import { getHospitalizationCost } from "../../Hospital/Hospital"; import { HacknetServer } from "../../Hacknet/HacknetServer"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatMoney } from "../../ui/formatNumber"; import { MoneySourceTracker } from "../../utils/MoneySourceTracker"; import { dialogBoxCreate } from "../../ui/React/DialogBox"; @@ -257,7 +257,7 @@ export function takeDamage(this: PlayerObject, amt: number): boolean { export function hospitalize(this: PlayerObject): number { const cost = getHospitalizationCost(); - SnackbarEvents.emit(`You've been Hospitalized for ${numeralWrapper.formatMoney(cost)}`, ToastVariant.SUCCESS, 2000); + SnackbarEvents.emit(`You've been Hospitalized for ${formatMoney(cost)}`, ToastVariant.SUCCESS, 2000); this.loseMoney(cost, "hospitalization"); this.hp.current = this.hp.max; @@ -1164,7 +1164,7 @@ export function gainCodingContractReward( default: { const moneyGain = CONSTANTS.CodingContractBaseMoneyGain * difficulty * BitNodeMultipliers.CodingContractMoney; this.gainMoney(moneyGain, "codingcontract"); - return `Gained ${numeralWrapper.formatMoney(moneyGain)}`; + return `Gained ${formatMoney(moneyGain)}`; } } /* eslint-enable no-case-declarations */ diff --git a/src/PersonObjects/Sleeve/Sleeve.ts b/src/PersonObjects/Sleeve/Sleeve.ts index f399be09a..050ba2ef0 100644 --- a/src/PersonObjects/Sleeve/Sleeve.ts +++ b/src/PersonObjects/Sleeve/Sleeve.ts @@ -23,7 +23,7 @@ import { CityName, CrimeType, GymType, LocationName, UniversityClassType } from import { Factions } from "../../Faction/Factions"; import { Generic_fromJSON, Generic_toJSON, IReviverValue, Reviver } from "../../utils/JSONReviver"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatPercent } from "../../ui/formatNumber"; import { FactionWorkType } from "../../Enums"; import { Work } from "./Work/Work"; import { SleeveClassWork } from "./Work/SleeveClassWork"; @@ -438,7 +438,7 @@ export class Sleeve extends Person implements SleevePerson { if (chances[0] >= 1) { return "100%"; } else { - return `${numeralWrapper.formatPercentage(chances[0])} - ${numeralWrapper.formatPercentage(chances[1])}`; + return `${formatPercent(chances[0])} - ${formatPercent(chances[1])}`; } } diff --git a/src/PersonObjects/Sleeve/ui/CovenantSleeveMemoryUpgrade.tsx b/src/PersonObjects/Sleeve/ui/CovenantSleeveMemoryUpgrade.tsx index 297073156..4b830aed2 100644 --- a/src/PersonObjects/Sleeve/ui/CovenantSleeveMemoryUpgrade.tsx +++ b/src/PersonObjects/Sleeve/ui/CovenantSleeveMemoryUpgrade.tsx @@ -7,7 +7,7 @@ import React, { useState } from "react"; import { Sleeve } from "../Sleeve"; import { Player } from "@player"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatSleeveMemory } from "../../../ui/formatNumber"; import { Money } from "../../../ui/React/Money"; import Typography from "@mui/material/Typography"; @@ -80,7 +80,7 @@ export function CovenantSleeveMemoryUpgrade(props: IProps): React.ReactElement { Purchase a memory upgrade for your sleeve. Note that a sleeve's max memory is 100 (current:{" "} - {numeralWrapper.formatSleeveMemory(props.sleeve.memory)}) + {formatSleeveMemory(props.sleeve.memory)}) diff --git a/src/PersonObjects/Sleeve/ui/MoreStatsModal.tsx b/src/PersonObjects/Sleeve/ui/MoreStatsModal.tsx index 23a0c7ef0..fdc29f7eb 100644 --- a/src/PersonObjects/Sleeve/ui/MoreStatsModal.tsx +++ b/src/PersonObjects/Sleeve/ui/MoreStatsModal.tsx @@ -1,5 +1,5 @@ import { Sleeve } from "../Sleeve"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatExp, formatPercent } from "../../../ui/formatNumber"; import { convertTimeMsToTimeElapsedString } from "../../../utils/StringHelperFunctions"; import { CONSTANTS } from "../../../Constants"; import { Typography } from "@mui/material"; @@ -18,74 +18,39 @@ export function MoreStatsModal(props: IProps): React.ReactElement { Hacking: , - props.sleeve.skills.hacking, - <> ({numeralWrapper.formatExp(props.sleeve.exp.hacking)} exp), - ], - [ - <>Strength: , - props.sleeve.skills.strength, - <> ({numeralWrapper.formatExp(props.sleeve.exp.strength)} exp), - ], - [ - <>Defense: , - props.sleeve.skills.defense, - <> ({numeralWrapper.formatExp(props.sleeve.exp.defense)} exp), - ], + [<>Hacking: , props.sleeve.skills.hacking, <> ({formatExp(props.sleeve.exp.hacking)} exp)], + [<>Strength: , props.sleeve.skills.strength, <> ({formatExp(props.sleeve.exp.strength)} exp)], + [<>Defense: , props.sleeve.skills.defense, <> ({formatExp(props.sleeve.exp.defense)} exp)], [ <>Dexterity: , props.sleeve.skills.dexterity, - <> ({numeralWrapper.formatExp(props.sleeve.exp.dexterity)} exp), - ], - [ - <>Agility: , - props.sleeve.skills.agility, - <> ({numeralWrapper.formatExp(props.sleeve.exp.agility)} exp), - ], - [ - <>Charisma: , - props.sleeve.skills.charisma, - <> ({numeralWrapper.formatExp(props.sleeve.exp.charisma)} exp), + <> ({formatExp(props.sleeve.exp.dexterity)} exp), ], + [<>Agility: , props.sleeve.skills.agility, <> ({formatExp(props.sleeve.exp.agility)} exp)], + [<>Charisma: , props.sleeve.skills.charisma, <> ({formatExp(props.sleeve.exp.charisma)} exp)], ]} title="Stats:" />
Hacking Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.hacking)], - [<>Hacking Experience multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.hacking_exp)], - [<>Strength Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.strength)], - [ - <>Strength Experience multiplier: , - numeralWrapper.formatPercentage(props.sleeve.mults.strength_exp), - ], - [<>Defense Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.defense)], - [<>Defense Experience multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.defense_exp)], - [<>Dexterity Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.dexterity)], - [ - <>Dexterity Experience multiplier: , - numeralWrapper.formatPercentage(props.sleeve.mults.dexterity_exp), - ], - [<>Agility Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.agility)], - [<>Agility Experience multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.agility_exp)], - [<>Charisma Level multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.charisma)], - [ - <>Charisma Experience multiplier: , - numeralWrapper.formatPercentage(props.sleeve.mults.charisma_exp), - ], - [ - <>Faction Reputation Gain multiplier: , - numeralWrapper.formatPercentage(props.sleeve.mults.faction_rep), - ], - [ - <>Company Reputation Gain multiplier: , - numeralWrapper.formatPercentage(props.sleeve.mults.company_rep), - ], - [<>Salary multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.work_money)], - [<>Crime Money multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.crime_money)], - [<>Crime Success multiplier: , numeralWrapper.formatPercentage(props.sleeve.mults.crime_success)], + [<>Hacking Level multiplier: , formatPercent(props.sleeve.mults.hacking)], + [<>Hacking Experience multiplier: , formatPercent(props.sleeve.mults.hacking_exp)], + [<>Strength Level multiplier: , formatPercent(props.sleeve.mults.strength)], + [<>Strength Experience multiplier: , formatPercent(props.sleeve.mults.strength_exp)], + [<>Defense Level multiplier: , formatPercent(props.sleeve.mults.defense)], + [<>Defense Experience multiplier: , formatPercent(props.sleeve.mults.defense_exp)], + [<>Dexterity Level multiplier: , formatPercent(props.sleeve.mults.dexterity)], + [<>Dexterity Experience multiplier: , formatPercent(props.sleeve.mults.dexterity_exp)], + [<>Agility Level multiplier: , formatPercent(props.sleeve.mults.agility)], + [<>Agility Experience multiplier: , formatPercent(props.sleeve.mults.agility_exp)], + [<>Charisma Level multiplier: , formatPercent(props.sleeve.mults.charisma)], + [<>Charisma Experience multiplier: , formatPercent(props.sleeve.mults.charisma_exp)], + [<>Faction Reputation Gain multiplier: , formatPercent(props.sleeve.mults.faction_rep)], + [<>Company Reputation Gain multiplier: , formatPercent(props.sleeve.mults.company_rep)], + [<>Salary multiplier: , formatPercent(props.sleeve.mults.work_money)], + [<>Crime Money multiplier: , formatPercent(props.sleeve.mults.crime_money)], + [<>Crime Success multiplier: , formatPercent(props.sleeve.mults.crime_success)], ]} title="Multipliers:" /> diff --git a/src/PersonObjects/Sleeve/ui/SleeveElem.tsx b/src/PersonObjects/Sleeve/ui/SleeveElem.tsx index 94ebbbaca..ce41749d3 100644 --- a/src/PersonObjects/Sleeve/ui/SleeveElem.tsx +++ b/src/PersonObjects/Sleeve/ui/SleeveElem.tsx @@ -3,7 +3,7 @@ import React, { useState } from "react"; import { FactionWorkType } from "../../../Enums"; import { CONSTANTS } from "../../../Constants"; import { Player } from "@player"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { formatPercent } from "../../../ui/formatNumber"; import { ProgressBar } from "../../../ui/React/Progress"; import { Sleeve } from "../Sleeve"; import { MoreStatsModal } from "./MoreStatsModal"; @@ -77,7 +77,7 @@ export function SleeveElem(props: IProps): React.ReactElement { desc = ( <> This sleeve is currently attempting {crime.workName} (Success Rate:{" "} - {numeralWrapper.formatPercentage(crime.successRate(props.sleeve))}). + {formatPercent(crime.successRate(props.sleeve))}). ); } diff --git a/src/PersonObjects/Sleeve/ui/StatsElement.tsx b/src/PersonObjects/Sleeve/ui/StatsElement.tsx index c44135813..6600bf5d0 100644 --- a/src/PersonObjects/Sleeve/ui/StatsElement.tsx +++ b/src/PersonObjects/Sleeve/ui/StatsElement.tsx @@ -4,7 +4,13 @@ import { Typography, Table, TableBody, TableCell, TableRow } from "@mui/material import { CONSTANTS } from "../../../Constants"; -import { numeralWrapper } from "../../../ui/numeralFormat"; +import { + formatExp, + formatHp, + formatSleeveMemory, + formatSleeveShock, + formatSleeveSynchro, +} from "../../../ui/formatNumber"; import { Settings } from "../../../Settings/Settings"; import { StatsRow } from "../../../ui/React/StatsRow"; import { characterOverviewStyles as useStyles } from "../../../ui/React/CharacterOverview"; @@ -35,9 +41,7 @@ export function StatsElement(props: IProps): React.ReactElement { name="HP" color={Settings.theme.hp} data={{ - content: `${numeralWrapper.formatHp(props.sleeve.hp.current)} / ${numeralWrapper.formatHp( - props.sleeve.hp.max, - )}`, + content: `${formatHp(props.sleeve.hp.current)} / ${formatHp(props.sleeve.hp.max)}`, }} /> @@ -103,36 +107,36 @@ export function EarningsElement(props: IProps): React.ReactElement { const gains = props.sleeve.currentWork.getExp(props.sleeve); data = [ [`Money:`, ], - [`Hacking Exp:`, `${numeralWrapper.formatExp(gains.hackExp)}`], - [`Strength Exp:`, `${numeralWrapper.formatExp(gains.strExp)}`], - [`Defense Exp:`, `${numeralWrapper.formatExp(gains.defExp)}`], - [`Dexterity Exp:`, `${numeralWrapper.formatExp(gains.dexExp)}`], - [`Agility Exp:`, `${numeralWrapper.formatExp(gains.agiExp)}`], - [`Charisma Exp:`, `${numeralWrapper.formatExp(gains.chaExp)}`], + [`Hacking Exp:`, `${formatExp(gains.hackExp)}`], + [`Strength Exp:`, `${formatExp(gains.strExp)}`], + [`Defense Exp:`, `${formatExp(gains.defExp)}`], + [`Dexterity Exp:`, `${formatExp(gains.dexExp)}`], + [`Agility Exp:`, `${formatExp(gains.agiExp)}`], + [`Charisma Exp:`, `${formatExp(gains.chaExp)}`], ]; } if (isSleeveClassWork(props.sleeve.currentWork)) { const rates = props.sleeve.currentWork.calculateRates(props.sleeve); data = [ [`Money:`, ], - [`Hacking Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], - [`Strength Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], - [`Defense Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], - [`Dexterity Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], - [`Agility Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], - [`Charisma Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], + [`Hacking Exp:`, `${formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], + [`Strength Exp:`, `${formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], + [`Defense Exp:`, `${formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], + [`Dexterity Exp:`, `${formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], + [`Agility Exp:`, `${formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], + [`Charisma Exp:`, `${formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], ]; } if (isSleeveFactionWork(props.sleeve.currentWork)) { const rates = props.sleeve.currentWork.getExpRates(props.sleeve); const repGain = props.sleeve.currentWork.getReputationRate(props.sleeve); data = [ - [`Hacking Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], - [`Strength Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], - [`Defense Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], - [`Dexterity Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], - [`Agility Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], - [`Charisma Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], + [`Hacking Exp:`, `${formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], + [`Strength Exp:`, `${formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], + [`Defense Exp:`, `${formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], + [`Dexterity Exp:`, `${formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], + [`Agility Exp:`, `${formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], + [`Charisma Exp:`, `${formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], [`Reputation:`, ], ]; } @@ -141,12 +145,12 @@ export function EarningsElement(props: IProps): React.ReactElement { const rates = props.sleeve.currentWork.getGainRates(props.sleeve); data = [ [`Money:`, ], - [`Hacking Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], - [`Strength Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], - [`Defense Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], - [`Dexterity Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], - [`Agility Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], - [`Charisma Exp:`, `${numeralWrapper.formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], + [`Hacking Exp:`, `${formatExp(CYCLES_PER_SEC * rates.hackExp)} / sec`], + [`Strength Exp:`, `${formatExp(CYCLES_PER_SEC * rates.strExp)} / sec`], + [`Defense Exp:`, `${formatExp(CYCLES_PER_SEC * rates.defExp)} / sec`], + [`Dexterity Exp:`, `${formatExp(CYCLES_PER_SEC * rates.dexExp)} / sec`], + [`Agility Exp:`, `${formatExp(CYCLES_PER_SEC * rates.agiExp)} / sec`], + [`Charisma Exp:`, `${formatExp(CYCLES_PER_SEC * rates.chaExp)} / sec`], [`Reputation:`, ], ]; } diff --git a/src/Programs/data/ProgramsMetadata.ts b/src/Programs/data/ProgramsMetadata.ts index 106138f6c..594befad0 100644 --- a/src/Programs/data/ProgramsMetadata.ts +++ b/src/Programs/data/ProgramsMetadata.ts @@ -6,7 +6,7 @@ import { Terminal } from "../../Terminal"; import { Player } from "@player"; import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; import { GetServer } from "../../Server/AllServers"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatMoney } from "../../ui/formatNumber"; import { BitNodeMultipliers } from "../../BitNode/BitNodeMultipliers"; import { BitFlumeEvent } from "../../BitNode/ui/BitFlumeModal"; import { calculateHackingTime, calculateGrowTime, calculateWeakenTime } from "../../Hacking"; @@ -311,7 +311,7 @@ export const programsMetadata: IProgramCreationParams[] = [ Player.augmentations.length >= numAugReq && Player.money > 1e11 && Player.skills.hacking >= 2500; if (!fulfilled) { Terminal.print(`Augmentations: ${Player.augmentations.length} / ${numAugReq}`); - Terminal.print(`Money: ${numeralWrapper.formatMoney(Player.money)} / $100b`); + Terminal.print(`Money: ${formatMoney(Player.money)} / $100b`); Terminal.print(`Hacking skill: ${Player.skills.hacking} / 2500`); return; } diff --git a/src/Script/ScriptHelpers.ts b/src/Script/ScriptHelpers.ts index 84aafc883..1097584f4 100644 --- a/src/Script/ScriptHelpers.ts +++ b/src/Script/ScriptHelpers.ts @@ -6,7 +6,7 @@ import { RunningScript } from "./RunningScript"; import { processSingleServerGrowth } from "../Server/ServerHelpers"; import { GetServer } from "../Server/AllServers"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatPercent } from "../ui/formatNumber"; import { compareArrays } from "../utils/helpers/compareArrays"; @@ -44,9 +44,7 @@ export function scriptCalculateOfflineProduction(runningScript: RunningScript): if (host === null) throw new Error("getServer of null key?"); if (!(serv instanceof Server)) throw new Error("trying to grow a non-normal server"); const growth = processSingleServerGrowth(serv, timesGrown, host.cpuCores); - runningScript.log( - `'${serv.hostname}' grown by ${numeralWrapper.format(growth * 100 - 100, "0.000000%")} while offline`, - ); + runningScript.log(`'${serv.hostname}' grown by ${formatPercent(growth - 1, 6)} while offline`); } } diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 04e6e9252..9daad20ce 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1001,7 +1001,7 @@ interface NetscriptPort { * Stock market API * @public */ -export type TIX = { +export interface TIX { /** * Returns true if the player has access to a WSE Account * @remarks RAM cost: 0.05 GB @@ -1440,7 +1440,7 @@ export type TIX = { * @returns True if you successfully purchased it or if you already have access, false otherwise. */ purchaseTixApi(): boolean; -}; +} /** * Singularity API @@ -1449,7 +1449,7 @@ export type TIX = { * Source-File 4 levels. * @public */ -export type Singularity = { +export interface Singularity { /** * Backup game save. * @remarks @@ -2293,7 +2293,7 @@ export type Singularity = { * @returns - An object representing the current work. Fields depend on the kind of work. */ getCurrentWork(): any | null; -}; +} /** * Hacknet API @@ -2301,7 +2301,7 @@ export type Singularity = { * Not all these functions are immediately available. * @public */ -export type Hacknet = { +export interface Hacknet { /** * Get the number of hacknet nodes you own. * @remarks @@ -2652,7 +2652,7 @@ export type Hacknet = { * @returns Multiplier. */ getTrainingMult(): number; -}; +} /** * Bladeburner API @@ -2661,7 +2661,7 @@ export type Hacknet = { * or have Source-File 7 in order to use this API. * @public */ -export type Bladeburner = { +export interface Bladeburner { /** * List all contracts. * @remarks @@ -3162,13 +3162,13 @@ export type Bladeburner = { * * @returns whether player is a member of bladeburner division. */ inBladeburner(): boolean; -}; +} /** * Coding Contract API * @public */ -export type CodingContract = { +export interface CodingContract { /** * Attempts a coding contract, returning a reward string on success or empty string on failure. * @remarks @@ -3273,7 +3273,7 @@ export type CodingContract = { * RAM cost: 2 GB */ getContractTypes(): string[]; -}; +} /** * Gang API @@ -3281,7 +3281,7 @@ export type CodingContract = { * If you are not in BitNode-2, then you must have Source-File 2 in order to use this API. * @public */ -export type Gang = { +export interface Gang { /** * Create a gang. * @remarks @@ -3540,7 +3540,7 @@ export type Gang = { * @returns Bonus time for the Gang mechanic in milliseconds. */ getBonusTime(): number; -}; +} /** * Sleeve API @@ -3548,7 +3548,7 @@ export type Gang = { * If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. * @public */ -export type Sleeve = { +export interface Sleeve { /** * Get the number of sleeves you own. * @remarks @@ -3778,7 +3778,7 @@ export type Sleeve = { * @returns True if the sleeve started working out, false otherwise. */ setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean; -}; +} /** * Grafting API @@ -3786,7 +3786,7 @@ export type Sleeve = { * This API requires Source-File 10 to use. * @public */ -export type Grafting = { +export interface Grafting { /** * Retrieve the grafting cost of an aug. * @remarks @@ -3833,13 +3833,13 @@ export type Grafting = { * @throws Will error if called while you are not in New Tokyo. */ graftAugmentation(augName: string, focus?: boolean): boolean; -}; +} /** * Skills formulas * @public */ -type SkillsFormulas = { +interface SkillsFormulas { /** * Calculate skill level. * @param exp - experience for that skill @@ -3854,7 +3854,7 @@ type SkillsFormulas = { * @returns The calculated exp required. */ calculateExp(skill: number, skillMult?: number): number; -}; +} /** @public */ interface WorkStats { @@ -3873,7 +3873,7 @@ interface WorkStats { * Work formulas * @public */ -type WorkFormulas = { +interface WorkFormulas { crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number; /** @returns The WorkStats gained when completing one instance of the specified crime. */ crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; @@ -3889,13 +3889,13 @@ type WorkFormulas = { factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats; /** @returns The WorkStats applied every game cycle (200ms) by performing the specified company work. */ companyGains(person: Person, companyName: string, workType: JobName | `${JobName}`, favor: number): WorkStats; -}; +} /** * Reputation formulas * @public */ -type ReputationFormulas = { +interface ReputationFormulas { /** * Calculate the total required amount of faction reputation to reach a target favor. * @param favor - target faction favor. @@ -3916,13 +3916,13 @@ type ReputationFormulas = { * @param player - Player info from {@link NS.getPlayer | getPlayer} */ repFromDonation(amount: number, player: Person): number; -}; +} /** * Hacking formulas * @public */ -type HackingFormulas = { +interface HackingFormulas { /** * Calculate hack chance. * (Ex: 0.25 would indicate a 25% chance of success.) @@ -3982,13 +3982,13 @@ type HackingFormulas = { * @returns The calculated weaken time. */ weakenTime(server: Server, player: Person): number; -}; +} /** * Hacknet Node formulas * @public */ -type HacknetNodesFormulas = { +interface HacknetNodesFormulas { /** * Calculate money gain rate. * @param level - level of the node. @@ -4034,13 +4034,13 @@ type HacknetNodesFormulas = { * @returns An object with all hacknet node constants used by the game. */ constants(): HacknetNodeConstants; -}; +} /** * Hacknet Server formulas * @public */ -type HacknetServersFormulas = { +interface HacknetServersFormulas { /** * Calculate hash gain rate. * @param level - level of the server. @@ -4101,13 +4101,13 @@ type HacknetServersFormulas = { * @returns An object with all hacknet server constants used by the game. */ constants(): HacknetServerConstants; -}; +} /** * Gang formulas * @public */ -type GangFormulas = { +interface GangFormulas { /** * Calculate the wanted penalty. * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} @@ -4152,7 +4152,7 @@ type GangFormulas = { * @returns The calculated ascension mult. */ ascensionMultiplier(points: number): number; -}; +} /** * Formulas API @@ -4160,7 +4160,7 @@ type GangFormulas = { * You need Formulas.exe on your home computer to use this API. * @public */ -export type Formulas = { +export interface Formulas { mockServer(): Server; mockPlayer(): Player; mockPerson(): Person; @@ -4178,7 +4178,7 @@ export type Formulas = { gang: GangFormulas; /** Work formulas */ work: WorkFormulas; -}; +} /** @public */ interface Fragment { @@ -4203,7 +4203,7 @@ interface ActiveFragment { * Stanek's Gift API. * @public */ -type Stanek = { +interface Stanek { /** * Stanek's Gift width. * @remarks @@ -4309,7 +4309,7 @@ type Stanek = { * false otherwise. */ acceptGift(): boolean; -}; +} /** @public */ interface InfiltrationReward { @@ -4335,7 +4335,7 @@ interface InfiltrationLocation { * Infiltration API. * @public */ -type Infiltration = { +interface Infiltration { /** * Get all locations that can be infiltrated. * @remarks @@ -4352,13 +4352,13 @@ type Infiltration = { * @returns Infiltration data for given location. */ getInfiltration(location: string): InfiltrationLocation; -}; +} /** * User Interface API. * @public */ -type UserInterface = { +interface UserInterface { /** * Get the current window size * @remarks @@ -4441,7 +4441,7 @@ type UserInterface = { * RAM cost: 0.2 GB */ clearTerminal(): void; -}; +} /** * Collection of all functions passed to scripts @@ -4470,7 +4470,7 @@ type UserInterface = { * {@link https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} *
*/ -export type NS = { +export interface NS { /** * Namespace for hacknet functions. * @remarks RAM cost: 4 GB @@ -6546,14 +6546,63 @@ export type NS = { * @remarks * RAM cost: 0 GB * - * Converts a number into a string with the specified formatter. - * This uses the numeral.js library, so the formatters must be compatible with that. - * This is the same function that the game itself uses to display numbers. - * - * For more information, see: http://numeraljs.com/ + * Converts a number into a numeric string with the specified format options. + * This is the same function that the game itself uses to display numbers. The format also depends on the Numeric + * Display settings (all options on the "Numeric Display" options page) + * To format ram or percentages, see {@link NS.formatRam | formatRam} and {@link NS.formatPercent | formatPercent} * * @param n - Number to format. - * @param format - Formatter. + * @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3. + * @param suffixStart - How high a number must be before a suffix will be added. Optional, defaults to 1000. + * @param isInteger - Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false. + * @returns Formatted number. + */ + formatNumber(n: number, fractionalDigits?: number, suffixStart?: number, isInteger?: boolean): string; + + /** + * Format a number as an amount of ram. + * @remarks + * RAM cost: 0 GB + * + * Converts a number into a ram string with the specified number of fractional digits. + * This is the same function that the game itself uses to display ram. The format also depends on the Numeric Display + * settings (all options on the "Numeric Display" options page) + * To format plain numbers or percentages, see {@link NS.formatNumber | formatNumber} and {@link NS.formatPercent | formatPercent} + * + * @param n - Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set). + * @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. + * @returns Formatted ram amount. + */ + formatRam(n: number, fractionalDigits?: number): string; + + /** + * Format a number as a percentage. + * @remarks + * RAM cost: 0 GB + * + * Converts a number into a percentage string with the specified number of fractional digits. + * This is the same function that the game itself uses to display percentages. The format also depends on the Numeric + * Display settings (all options on the "Numeric Display" options page) + * To format plain numbers or ram, see {@link NS.formatNumber | formatNumber} and {@link NS.formatRam | formatRam} + * + * @param n - Number to format as a percentage. + * @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. + * @returns Formatted percentage. + */ + formatPercent(n: number, fractionalDigits?: number): string; + + /** + * Format a number using the numeral library. This function is deprecated and will be removed in 2.3. + * @remarks + * RAM cost: 0 GB + * + * Converts a number into a string with the specified format options. + * See http://numeraljs.com/#format for documentation on format strings supported. + * + * This function is deprecated and will be removed in 2.3. + * + * @param n - Number to format. + * @param format - Formatting options. See http://numeraljs.com/#format for valid formats. * @returns Formatted number. */ nFormat(n: number, format: string): string; @@ -6867,7 +6916,7 @@ export type NS = { getSharePower(): number; enums: NSEnums; -}; +} // BASE ENUMS /** @public */ @@ -7087,7 +7136,7 @@ export type NSEnums = { * @public */ -export type OfficeAPI = { +export interface OfficeAPI { /** * Hire an employee. * @param divisionName - Name of the division @@ -7179,7 +7228,7 @@ export type OfficeAPI = { * @returns Cost of upgrading the office */ getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, asize: number): number; -}; +} /** * Corporation Warehouse API @@ -7187,7 +7236,7 @@ export type OfficeAPI = { * Requires the Warehouse API upgrade from your corporation. * @public */ -export type WarehouseAPI = { +export interface WarehouseAPI { /** * Set material sell data. * @param divisionName - Name of the division @@ -7410,13 +7459,13 @@ export type WarehouseAPI = { * @returns true if warehouse is present, false if not */ hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; -}; +} /** * Corporation API * @public */ -export type Corporation = { +export interface Corporation extends WarehouseAPI, OfficeAPI { /** Returns whether the player has a corporation. Does not require API access. * @returns whether the player has a corporation */ hasCorporation(): boolean; @@ -7527,12 +7576,11 @@ export type Corporation = { * “Bonus time” makes the game progress faster. * @returns Bonus time for the Corporation mechanic in milliseconds. */ getBonusTime(): number; -} & WarehouseAPI & - OfficeAPI; +} /** Product rating information * @public */ -type CorpProductData = { +interface CorpProductData { /** Name of the product */ name: string; /** Verb used to describe creation of the product */ @@ -7548,7 +7596,7 @@ type CorpProductData = { performance?: number; reliability?: number; }; -}; +} /** Data for an individual industry * @public */ diff --git a/src/ScriptEditor/ui/ScriptEditorRoot.tsx b/src/ScriptEditor/ui/ScriptEditorRoot.tsx index 0bc28ae90..870838032 100644 --- a/src/ScriptEditor/ui/ScriptEditorRoot.tsx +++ b/src/ScriptEditor/ui/ScriptEditorRoot.tsx @@ -16,7 +16,7 @@ import { Script } from "../../Script/Script"; import { TextFile } from "../../TextFile"; import { calculateRamUsage, checkInfiniteLoop } from "../../Script/RamCalculations"; import { RamCalculationErrorCode } from "../../Script/RamCalculationErrorCodes"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { DragDropContext, Droppable, Draggable } from "react-beautiful-dnd"; import SearchIcon from "@mui/icons-material/Search"; @@ -256,10 +256,10 @@ export function Root(props: IProps): React.ReactElement { const entries = ramUsage.entries?.sort((a, b) => b.cost - a.cost) ?? []; const entriesDisp = []; for (const entry of entries) { - entriesDisp.push([`${entry.name} (${entry.type})`, numeralWrapper.formatRAM(entry.cost)]); + entriesDisp.push([`${entry.name} (${entry.type})`, formatRam(entry.cost)]); } - setRAM("RAM: " + numeralWrapper.formatRAM(ramUsage.cost)); + setRAM("RAM: " + formatRam(ramUsage.cost)); setRamEntries(entriesDisp); return; } diff --git a/src/Settings/Settings.ts b/src/Settings/Settings.ts index a2c87e41b..c15c29f4d 100644 --- a/src/Settings/Settings.ts +++ b/src/Settings/Settings.ts @@ -85,6 +85,14 @@ export const Settings = { MonacoVim: false, /** Word wrap setting for Script Editor. */ MonacoWordWrap: "off" as WordWrapOptions, + /** Whether to hide trailing zeroes on fractional part of decimal */ + hideTrailingDecimalZeros: false, + /** Whether to hide thousands separators. */ + hideThousandsSeparator: false, + /** Whether to use engineering notation instead of scientific for exponentials. */ + useEngineeringNotation: false, + /** Whether to disable suffixes and always use exponential form (scientific or engineering). */ + disableSuffixes: false, load(saveString: string) { const save = JSON.parse(saveString); diff --git a/src/StockMarket/BuyingAndSelling.tsx b/src/StockMarket/BuyingAndSelling.tsx index c00aad37b..853d07bd7 100644 --- a/src/StockMarket/BuyingAndSelling.tsx +++ b/src/StockMarket/BuyingAndSelling.tsx @@ -14,7 +14,7 @@ import { PositionTypes } from "./data/PositionTypes"; import { CONSTANTS } from "../Constants"; import { Player } from "@player"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatMoney, formatShares } from "../ui/formatNumber"; import { Money } from "../ui/React/Money"; import { dialogBoxCreate } from "../ui/React/DialogBox"; @@ -67,8 +67,7 @@ export function buyStock( if (ctx) { helpers.log( ctx, - () => - `You do not have enough money to purchase this position. You need ${numeralWrapper.formatMoney(totalPrice)}.`, + () => `You do not have enough money to purchase this position. You need ${formatMoney(totalPrice)}.`, ); } else if (opts.suppressDialog !== true) { dialogBoxCreate( @@ -93,7 +92,7 @@ export function buyStock( ); } else if (opts.suppressDialog !== true) { dialogBoxCreate( - `You cannot purchase this many shares. ${stock.symbol} has a maximum of ${numeralWrapper.formatShares( + `You cannot purchase this many shares. ${stock.symbol} has a maximum of ${formatShares( stock.maxShares, )} shares.`, ); @@ -113,16 +112,14 @@ export function buyStock( } if (ctx) { - const resultTxt = `Bought ${numeralWrapper.formatShares(shares)} shares of ${ - stock.symbol - } for ${numeralWrapper.formatMoney(totalPrice)}. Paid ${numeralWrapper.formatMoney( - CONSTANTS.StockMarketCommission, - )} in commission fees.`; + const resultTxt = `Bought ${formatShares(shares)} shares of ${stock.symbol} for ${formatMoney( + totalPrice, + )}. Paid ${formatMoney(CONSTANTS.StockMarketCommission)} in commission fees.`; helpers.log(ctx, () => resultTxt); } else if (opts.suppressDialog !== true) { dialogBoxCreate( <> - Bought {numeralWrapper.formatShares(shares)} shares of {stock.symbol} for . Paid{" "} + Bought {formatShares(shares)} shares of {stock.symbol} for . Paid{" "} in commission fees. , ); @@ -192,13 +189,13 @@ export function sellStock( if (ctx) { const resultTxt = - `Sold ${numeralWrapper.formatShares(shares)} shares of ${stock.symbol}. ` + - `After commissions, you gained a total of ${numeralWrapper.formatMoney(gains)}.`; + `Sold ${formatShares(shares)} shares of ${stock.symbol}. ` + + `After commissions, you gained a total of ${formatMoney(gains)}.`; helpers.log(ctx, () => resultTxt); } else if (opts.suppressDialog !== true) { dialogBoxCreate( <> - Sold {numeralWrapper.formatShares(shares)} shares of {stock.symbol}. After commissions, you gained a total of{" "} + Sold {formatShares(shares)} shares of {stock.symbol}. After commissions, you gained a total of{" "} . , ); @@ -247,10 +244,7 @@ export function shortStock( if (ctx) { helpers.log( ctx, - () => - "You do not have enough " + - "money to purchase this short position. You need " + - numeralWrapper.formatMoney(totalPrice), + () => "You do not have enough " + "money to purchase this short position. You need " + formatMoney(totalPrice), ); } else if (opts.suppressDialog !== true) { dialogBoxCreate( @@ -295,17 +289,15 @@ export function shortStock( if (ctx) { const resultTxt = - `Bought a short position of ${numeralWrapper.formatShares(shares)} shares of ${stock.symbol} ` + - `for ${numeralWrapper.formatMoney(totalPrice)}. Paid ${numeralWrapper.formatMoney( - CONSTANTS.StockMarketCommission, - )} ` + + `Bought a short position of ${formatShares(shares)} shares of ${stock.symbol} ` + + `for ${formatMoney(totalPrice)}. Paid ${formatMoney(CONSTANTS.StockMarketCommission)} ` + `in commission fees.`; helpers.log(ctx, () => resultTxt); } else if (!opts.suppressDialog) { dialogBoxCreate( <> - Bought a short position of {numeralWrapper.formatShares(shares)} shares of {stock.symbol} for{" "} - . Paid in commission fees. + Bought a short position of {formatShares(shares)} shares of {stock.symbol} for . + Paid in commission fees. , ); } @@ -385,14 +377,14 @@ export function sellShort( if (ctx) { const resultTxt = - `Sold your short position of ${numeralWrapper.formatShares(shares)} shares of ${stock.symbol}. ` + - `After commissions, you gained a total of ${numeralWrapper.formatMoney(totalGain)}`; + `Sold your short position of ${formatShares(shares)} shares of ${stock.symbol}. ` + + `After commissions, you gained a total of ${formatMoney(totalGain)}`; helpers.log(ctx, () => resultTxt); } else if (!opts.suppressDialog) { dialogBoxCreate( <> - Sold your short position of {numeralWrapper.formatShares(shares)} shares of {stock.symbol}. After commissions, - you gained a total of + Sold your short position of {formatShares(shares)} shares of {stock.symbol}. After commissions, you gained a + total of , ); } diff --git a/src/StockMarket/OrderProcessing.tsx b/src/StockMarket/OrderProcessing.tsx index 51d14a0bd..d4fe9f4fa 100644 --- a/src/StockMarket/OrderProcessing.tsx +++ b/src/StockMarket/OrderProcessing.tsx @@ -11,7 +11,7 @@ import { Stock } from "./Stock"; import { OrderTypes } from "./data/OrderTypes"; import { PositionTypes } from "./data/PositionTypes"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatShares } from "../ui/formatNumber"; import { Money } from "../ui/React/Money"; import { dialogBoxCreate } from "../ui/React/DialogBox"; @@ -153,7 +153,7 @@ function executeOrder(order: Order, refs: IProcessOrderRefs): void { dialogBoxCreate( <> {order.type} for {stock.symbol} @ ({pos}) was filled ( - {numeralWrapper.formatShares(Math.round(order.shares))} shares) + {formatShares(Math.round(order.shares))} shares) , ); } diff --git a/src/StockMarket/StockMarket.tsx b/src/StockMarket/StockMarket.tsx index a851a1a1f..896e70f6d 100644 --- a/src/StockMarket/StockMarket.tsx +++ b/src/StockMarket/StockMarket.tsx @@ -10,7 +10,7 @@ import { PositionTypes } from "./data/PositionTypes"; import { StockSymbols } from "./data/StockSymbols"; import { CONSTANTS } from "../Constants"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatMoney } from "../ui/formatNumber"; import { dialogBoxCreate } from "../ui/React/DialogBox"; import { Reviver } from "../utils/JSONReviver"; @@ -106,7 +106,7 @@ export function cancelOrder(params: ICancelOrderParams, ctx?: NetscriptContext): ) { // Order properties are passed in. Need to look for the order const stockOrders = StockMarket["Orders"][params.stock.symbol]; - const orderTxt = params.stock.symbol + " - " + params.shares + " @ " + numeralWrapper.formatMoney(params.price); + const orderTxt = params.stock.symbol + " - " + params.shares + " @ " + formatMoney(params.price); for (let i = 0; i < stockOrders.length; ++i) { const order = stockOrders[i]; if ( diff --git a/src/StockMarket/ui/StockTicker.tsx b/src/StockMarket/ui/StockTicker.tsx index e31232a30..08ee634af 100644 --- a/src/StockMarket/ui/StockTicker.tsx +++ b/src/StockMarket/ui/StockTicker.tsx @@ -15,7 +15,7 @@ import { placeOrder } from "../StockMarket"; import { buyStock, shortStock, sellStock, sellShort } from "../BuyingAndSelling"; import { Player } from "@player"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatShares } from "../../ui/formatNumber"; import { Money } from "../../ui/React/Money"; import { dialogBoxCreate } from "../../ui/React/DialogBox"; @@ -75,7 +75,7 @@ export function StockTicker(props: IProps): React.ReactElement { return ( <> - Purchasing {numeralWrapper.formatShares(qty)} shares ({position === PositionTypes.Long ? "Long" : "Short"} + Purchasing {formatShares(qty)} shares ({position === PositionTypes.Long ? "Long" : "Short"} ) will cost . ); @@ -107,8 +107,8 @@ export function StockTicker(props: IProps): React.ReactElement { return ( <> - Selling {numeralWrapper.formatShares(qty)} shares ({position === PositionTypes.Long ? "Long" : "Short"}) will - result in a gain of . + Selling {formatShares(qty)} shares ({position === PositionTypes.Long ? "Long" : "Short"}) will result in a gain + of . ); } diff --git a/src/StockMarket/ui/StockTickerHeaderText.tsx b/src/StockMarket/ui/StockTickerHeaderText.tsx index 34084e22a..f46659860 100644 --- a/src/StockMarket/ui/StockTickerHeaderText.tsx +++ b/src/StockMarket/ui/StockTickerHeaderText.tsx @@ -10,7 +10,7 @@ import { TickerHeaderFormatData } from "../data/TickerHeaderFormatData"; import { Player } from "@player"; import { Settings } from "../../Settings/Settings"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatMoney, formatPercent } from "../../ui/formatNumber"; import Typography from "@mui/material/Typography"; type IProps = { @@ -22,7 +22,7 @@ const localesWithLongPriceFormat = ["cs", "lv", "pl", "ru"]; export function StockTickerHeaderText(props: IProps): React.ReactElement { const stock = props.stock; - const stockPriceFormat = numeralWrapper.formatMoney(stock.price); + const stockPriceFormat = formatMoney(stock.price); const spacesAllottedForStockPrice = localesWithLongPriceFormat.includes(Settings.Locale) ? 15 : 12; const spacesAfterStockName = " ".repeat( 1 + @@ -34,7 +34,7 @@ export function StockTickerHeaderText(props: IProps): React.ReactElement { let hdrText = `${stock.name}${spacesAfterStockName}${stock.symbol} -${spacesBeforePrice}${stockPriceFormat}`; if (Player.has4SData) { - hdrText += ` - Volatility: ${numeralWrapper.formatPercentage(stock.mv / 100)} - Price Forecast: `; + hdrText += ` - Volatility: ${formatPercent(stock.mv / 100)} - Price Forecast: `; let plusOrMinus = stock.b; // True for "+", false for "-" if (stock.otlkMag < 0) { plusOrMinus = !plusOrMinus; diff --git a/src/StockMarket/ui/StockTickerOrder.tsx b/src/StockMarket/ui/StockTickerOrder.tsx index ec2b13378..5db81d559 100644 --- a/src/StockMarket/ui/StockTickerOrder.tsx +++ b/src/StockMarket/ui/StockTickerOrder.tsx @@ -3,7 +3,7 @@ import * as React from "react"; import { Order } from "../Order"; import { PositionTypes } from "../data/PositionTypes"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatShares } from "../../ui/formatNumber"; import { Money } from "../../ui/React/Money"; import Typography from "@mui/material/Typography"; import Button from "@mui/material/Button"; @@ -25,7 +25,7 @@ export function StockTickerOrder(props: IProps): React.ReactElement { const posTxt = order.pos === PositionTypes.Long ? "Long Position" : "Short Position"; const txt = ( <> - {order.type} - {posTxt} - {numeralWrapper.formatShares(order.shares)} @ + {order.type} - {posTxt} - {formatShares(order.shares)} @ ); diff --git a/src/StockMarket/ui/StockTickerPositionText.tsx b/src/StockMarket/ui/StockTickerPositionText.tsx index 1a24aaae7..ff0878c7e 100644 --- a/src/StockMarket/ui/StockTickerPositionText.tsx +++ b/src/StockMarket/ui/StockTickerPositionText.tsx @@ -7,7 +7,7 @@ import * as React from "react"; import { Stock } from "../Stock"; import { Player } from "@player"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatPercent, formatShares } from "../../ui/formatNumber"; import { Money } from "../../ui/React/Money"; import Typography from "@mui/material/Typography"; import Tooltip from "@mui/material/Tooltip"; @@ -43,12 +43,12 @@ function LongPosition(props: IProps): React.ReactElement { - Shares: {numeralWrapper.formatShares(stock.playerShares)} + Shares: {formatShares(stock.playerShares)} Average Price: (Total Cost: ) - Profit: ({numeralWrapper.formatPercentage(percentageGains)}) + Profit: ({formatPercent(percentageGains)}) ); @@ -82,12 +82,12 @@ function ShortPosition(props: IProps): React.ReactElement { - Shares: {numeralWrapper.formatShares(stock.playerShortShares)} + Shares: {formatShares(stock.playerShortShares)} Average Price: (Total Cost: ) - Profit: ({numeralWrapper.formatPercentage(percentageGains)}) + Profit: ({formatPercent(percentageGains)}) ); @@ -101,7 +101,7 @@ export function StockTickerPositionText(props: IProps): React.ReactElement { return ( <> - Max Shares: {numeralWrapper.formatShares(stock.maxShares)} + Max Shares: {formatShares(stock.maxShares)} Ask Price: diff --git a/src/Terminal/Terminal.ts b/src/Terminal/Terminal.ts index c331e8b17..3bfa67b03 100644 --- a/src/Terminal/Terminal.ts +++ b/src/Terminal/Terminal.ts @@ -30,7 +30,7 @@ import { calculateGrowTime, calculateWeakenTime, } from "../Hacking"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatExp, formatMoney, formatPercent, formatRam, formatSecurity } from "../ui/formatNumber"; import { convertTimeMsToTimeElapsedString } from "../utils/StringHelperFunctions"; // TODO: Does every terminal function really need its own file...? @@ -224,21 +224,17 @@ export class Terminal { const newSec = server.hackDifficulty; this.print( - `Hack successful on '${server.hostname}'! Gained ${numeralWrapper.formatMoney( - moneyGained, - )} and ${numeralWrapper.formatExp(expGainedOnSuccess)} hacking exp`, + `Hack successful on '${server.hostname}'! Gained ${formatMoney(moneyGained)} and ${formatExp( + expGainedOnSuccess, + )} hacking exp`, ); this.print( - `Security increased on '${server.hostname}' from ${numeralWrapper.formatSecurity( - oldSec, - )} to ${numeralWrapper.formatSecurity(newSec)}`, + `Security increased on '${server.hostname}' from ${formatSecurity(oldSec)} to ${formatSecurity(newSec)}`, ); } else { // Failure Player.gainHackingExp(expGainedOnFailure); - this.print( - `Failed to hack '${server.hostname}'. Gained ${numeralWrapper.formatExp(expGainedOnFailure)} hacking exp`, - ); + this.print(`Failed to hack '${server.hostname}'. Gained ${formatExp(expGainedOnFailure)} hacking exp`); } } @@ -257,15 +253,12 @@ export class Terminal { Player.gainHackingExp(expGain); this.print( - `Available money on '${server.hostname}' grown by ${numeralWrapper.formatPercentage( - growth, - 6, - )}. Gained ${numeralWrapper.formatExp(expGain)} hacking exp.`, + `Available money on '${server.hostname}' grown by ${formatPercent(growth, 6)}. Gained ${formatExp( + expGain, + )} hacking exp.`, ); this.print( - `Security increased on '${server.hostname}' from ${numeralWrapper.formatSecurity( - oldSec, - )} to ${numeralWrapper.formatSecurity(newSec)}`, + `Security increased on '${server.hostname}' from ${formatSecurity(oldSec)} to ${formatSecurity(newSec)}`, ); } @@ -284,10 +277,9 @@ export class Terminal { Player.gainHackingExp(expGain); this.print( - `Security decreased on '${server.hostname}' from ${numeralWrapper.formatSecurity( - oldSec, - )} to ${numeralWrapper.formatSecurity(newSec)} (min: ${numeralWrapper.formatSecurity(server.minDifficulty)})` + - ` and Gained ${numeralWrapper.formatExp(expGain)} hacking exp.`, + `Security decreased on '${server.hostname}' from ${formatSecurity(oldSec)} to ${formatSecurity( + newSec, + )} (min: ${formatSecurity(server.minDifficulty)})` + ` and Gained ${formatExp(expGain)} hacking exp.`, ); } @@ -320,22 +312,20 @@ export class Terminal { this.print("Root Access: " + (hasAdminRights ? "YES" : "NO")); const canRunScripts = hasAdminRights && currServ.maxRam > 0; this.print("Can run scripts on this host: " + (canRunScripts ? "YES" : "NO")); - this.print("RAM: " + numeralWrapper.formatRAM(currServ.maxRam)); + this.print("RAM: " + formatRam(currServ.maxRam)); if (currServ instanceof Server) { this.print("Backdoor: " + (currServ.backdoorInstalled ? "YES" : "NO")); const hackingSkill = currServ.requiredHackingSkill; this.print("Required hacking skill for hack() and backdoor: " + (!isHacknet ? hackingSkill : "N/A")); const security = currServ.hackDifficulty; - this.print("Server security level: " + (!isHacknet ? numeralWrapper.formatServerSecurity(security) : "N/A")); + this.print("Server security level: " + (!isHacknet ? formatSecurity(security) : "N/A")); const hackingChance = calculateHackingChance(currServ, Player); - this.print("Chance to hack: " + (!isHacknet ? numeralWrapper.formatPercentage(hackingChance) : "N/A")); + this.print("Chance to hack: " + (!isHacknet ? formatPercent(hackingChance) : "N/A")); const hackingTime = calculateHackingTime(currServ, Player) * 1000; this.print("Time to hack: " + (!isHacknet ? convertTimeMsToTimeElapsedString(hackingTime, true) : "N/A")); } this.print( - `Total money available on server: ${ - currServ instanceof Server ? numeralWrapper.formatMoney(currServ.moneyAvailable) : "N/A" - }`, + `Total money available on server: ${currServ instanceof Server ? formatMoney(currServ.moneyAvailable) : "N/A"}`, ); if (currServ instanceof Server) { const numPort = currServ.numOpenPortsRequired; @@ -559,7 +549,7 @@ export class Terminal { this.print(dashes + "Number of open ports required to NUKE: " + s.numOpenPortsRequired); } } - this.print(dashes + "RAM: " + numeralWrapper.formatRAM(s.maxRam)); + this.print(dashes + "RAM: " + formatRam(s.maxRam)); this.print(" "); } } diff --git a/src/Terminal/commands/free.ts b/src/Terminal/commands/free.ts index 88cc43ac4..3153f9ab6 100644 --- a/src/Terminal/commands/free.ts +++ b/src/Terminal/commands/free.ts @@ -1,17 +1,17 @@ import { Terminal } from "../../Terminal"; import { BaseServer } from "../../Server/BaseServer"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatPercent, formatRam } from "../../ui/formatNumber"; export function free(args: (string | number | boolean)[], server: BaseServer): void { if (args.length !== 0) { Terminal.error("Incorrect usage of free command. Usage: free"); return; } - const ram = numeralWrapper.formatRAM(server.maxRam); - const used = numeralWrapper.formatRAM(server.ramUsed); - const avail = numeralWrapper.formatRAM(server.maxRam - server.ramUsed); + const ram = formatRam(server.maxRam); + const used = formatRam(server.ramUsed); + const avail = formatRam(server.maxRam - server.ramUsed); const maxLength = Math.max(ram.length, Math.max(used.length, avail.length)); - const usedPercent = numeralWrapper.formatPercentage(server.ramUsed / server.maxRam); + const usedPercent = formatPercent(server.ramUsed / server.maxRam); Terminal.print(`Total: ${" ".repeat(maxLength - ram.length)}${ram}`); Terminal.print(`Used: ${" ".repeat(maxLength - used.length)}${used} (${usedPercent})`); diff --git a/src/Terminal/commands/mem.ts b/src/Terminal/commands/mem.ts index 17593096d..994361d2b 100644 --- a/src/Terminal/commands/mem.ts +++ b/src/Terminal/commands/mem.ts @@ -1,5 +1,5 @@ import { Terminal } from "../../Terminal"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; import { Settings } from "../../Settings/Settings"; export function mem(args: (string | number | boolean)[]): void { @@ -27,16 +27,12 @@ export function mem(args: (string | number | boolean)[]): void { const ramUsage = script.ramUsage * numThreads; - Terminal.print( - `This script requires ${numeralWrapper.formatRAM(ramUsage)} of RAM to run for ${numThreads} thread(s)`, - ); + Terminal.print(`This script requires ${formatRam(ramUsage)} of RAM to run for ${numThreads} thread(s)`); const verboseEntries = script.ramUsageEntries?.sort((a, b) => b.cost - a.cost) ?? []; const padding = Settings.UseIEC60027_2 ? 9 : 8; for (const entry of verboseEntries) { - Terminal.print( - `${numeralWrapper.formatRAM(entry.cost * numThreads).padStart(padding)} | ${entry.name} (${entry.type})`, - ); + Terminal.print(`${formatRam(entry.cost * numThreads).padStart(padding)} | ${entry.name} (${entry.type})`); } if (ramUsage > 0 && verboseEntries.length === 0) { diff --git a/src/Terminal/commands/runScript.ts b/src/Terminal/commands/runScript.ts index 64925aa23..97898b594 100644 --- a/src/Terminal/commands/runScript.ts +++ b/src/Terminal/commands/runScript.ts @@ -5,7 +5,7 @@ import { startWorkerScript } from "../../NetscriptWorker"; import { RunningScript } from "../../Script/RunningScript"; import { findRunningScript } from "../../Script/ScriptHelpers"; import * as libarg from "arg"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; export function runScript(commandArgs: (string | number | boolean)[], server: BaseServer): void { if (commandArgs.length < 1) { @@ -59,7 +59,7 @@ export function runScript(commandArgs: (string | number | boolean)[], server: Ba Terminal.error( "This machine does not have enough RAM to run this script" + (numThreads === 1 ? "" : ` with ${numThreads} threads`) + - `. Script requires ${numeralWrapper.formatRAM(ramUsage)} of RAM`, + `. Script requires ${formatRam(ramUsage)} of RAM`, ); return; } diff --git a/src/Terminal/commands/top.ts b/src/Terminal/commands/top.ts index ee815d43d..815eb66b8 100644 --- a/src/Terminal/commands/top.ts +++ b/src/Terminal/commands/top.ts @@ -1,7 +1,7 @@ import { Terminal } from "../../Terminal"; import { BaseServer } from "../../Server/BaseServer"; import { getRamUsageFromRunningScript } from "../../Script/RunningScriptHelpers"; -import { numeralWrapper } from "../../ui/numeralFormat"; +import { formatRam } from "../../ui/formatNumber"; export function top(args: (string | number | boolean)[], server: BaseServer): void { if (args.length !== 0) { @@ -45,7 +45,7 @@ export function top(args: (string | number | boolean)[], server: BaseServer): vo const spacesThread = " ".repeat(numSpacesThread); // Calculate and transform RAM usage - const ramUsage = numeralWrapper.formatRAM(getRamUsageFromRunningScript(script) * script.threads); + const ramUsage = formatRam(getRamUsageFromRunningScript(script) * script.threads); const entry = [script.filename, spacesScript, script.pid, spacesPid, script.threads, spacesThread, ramUsage].join( "", diff --git a/src/Work/ClassWork.tsx b/src/Work/ClassWork.tsx index d9bdcf829..23d603c78 100644 --- a/src/Work/ClassWork.tsx +++ b/src/Work/ClassWork.tsx @@ -2,7 +2,7 @@ import React from "react"; import { Reviver, Generic_toJSON, Generic_fromJSON, IReviverValue } from "../utils/JSONReviver"; import { CONSTANTS } from "../Constants"; import { LocationName } from "../Enums"; -import { numeralWrapper } from "../ui/numeralFormat"; +import { formatExp } from "../ui/formatNumber"; import { dialogBoxCreate } from "../ui/React/DialogBox"; import { Money } from "../ui/React/Money"; import { convertTimeMsToTimeElapsedString } from "../utils/StringHelperFunctions"; @@ -122,12 +122,12 @@ export class ClassWork extends Work { you spent a total of .

You earned a total of:
- {numeralWrapper.formatExp(this.earnings.hackExp)} hacking exp
- {numeralWrapper.formatExp(this.earnings.strExp)} strength exp
- {numeralWrapper.formatExp(this.earnings.defExp)} defense exp
- {numeralWrapper.formatExp(this.earnings.dexExp)} dexterity exp
- {numeralWrapper.formatExp(this.earnings.agiExp)} agility exp
- {numeralWrapper.formatExp(this.earnings.chaExp)} charisma exp + {formatExp(this.earnings.hackExp)} hacking exp
+ {formatExp(this.earnings.strExp)} strength exp
+ {formatExp(this.earnings.defExp)} defense exp
+ {formatExp(this.earnings.dexExp)} dexterity exp
+ {formatExp(this.earnings.agiExp)} agility exp
+ {formatExp(this.earnings.chaExp)} charisma exp
, ); diff --git a/src/engine.tsx b/src/engine.tsx index 87bea912d..d5692dbcd 100644 --- a/src/engine.tsx +++ b/src/engine.tsx @@ -26,7 +26,7 @@ import { Player } from "@player"; import { saveObject, loadGame } from "./SaveObject"; import { initForeignServers } from "./Server/AllServers"; import { Settings } from "./Settings/Settings"; -import { ThemeEvents } from "./Themes/ui/Theme"; +import { FormatsNeedToChange } from "./ui/formatNumber"; import { initSymbolToStockMap, processStockPrices } from "./StockMarket/StockMarket"; import { Terminal } from "./Terminal"; @@ -226,7 +226,7 @@ const Engine: { // Load game from save or create new game if (loadGame(saveString)) { - ThemeEvents.emit(); + FormatsNeedToChange.emit(); initSourceFiles(); initDarkWebItems(); initAugmentations(); // Also calls Player.reapplyAllAugmentations() @@ -370,6 +370,7 @@ const Engine: { ); } else { // No save found, start new game + FormatsNeedToChange.emit(); initSourceFiles(); initDarkWebItems(); Engine.start(); // Run main game loop and Scripts loop diff --git a/src/ui/ActiveScripts/RecentScriptAccordion.tsx b/src/ui/ActiveScripts/RecentScriptAccordion.tsx index e303ca2d6..f39f2785b 100644 --- a/src/ui/ActiveScripts/RecentScriptAccordion.tsx +++ b/src/ui/ActiveScripts/RecentScriptAccordion.tsx @@ -4,7 +4,7 @@ */ import * as React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatExp, formatThreads } from "../formatNumber"; import Table from "@mui/material/Table"; import TableCell from "@mui/material/TableCell"; @@ -73,7 +73,7 @@ export function RecentScriptAccordion(props: IProps): React.ReactElement { └ Threads: - {numeralWrapper.formatThreads(recentScript.runningScript.threads)} + {formatThreads(recentScript.runningScript.threads)} @@ -115,7 +115,7 @@ export function RecentScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(recentScript.runningScript.onlineExpGained) + " hacking exp"} +  {formatExp(recentScript.runningScript.onlineExpGained) + " hacking exp"} @@ -133,7 +133,7 @@ export function RecentScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(onlineEps) + " hacking exp / sec"} +  {formatExp(onlineEps) + " hacking exp / sec"} @@ -151,7 +151,7 @@ export function RecentScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(recentScript.runningScript.offlineExpGained) + " hacking exp"} +  {formatExp(recentScript.runningScript.offlineExpGained) + " hacking exp"} diff --git a/src/ui/ActiveScripts/WorkerScriptAccordion.tsx b/src/ui/ActiveScripts/WorkerScriptAccordion.tsx index 8145cd9f3..610f9e46f 100644 --- a/src/ui/ActiveScripts/WorkerScriptAccordion.tsx +++ b/src/ui/ActiveScripts/WorkerScriptAccordion.tsx @@ -4,7 +4,7 @@ */ import * as React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatExp, formatThreads } from "../formatNumber"; import Table from "@mui/material/Table"; import TableCell from "@mui/material/TableCell"; @@ -84,7 +84,7 @@ export function WorkerScriptAccordion(props: IProps): React.ReactElement { └ Threads: - {numeralWrapper.formatThreads(props.workerScript.scriptRef.threads)} + {formatThreads(props.workerScript.scriptRef.threads)} @@ -121,7 +121,7 @@ export function WorkerScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(scriptRef.onlineExpGained) + " hacking exp"} +  {formatExp(scriptRef.onlineExpGained) + " hacking exp"} @@ -138,7 +138,7 @@ export function WorkerScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(onlineEps) + " hacking exp / sec"} +  {formatExp(onlineEps) + " hacking exp / sec"} @@ -155,7 +155,7 @@ export function WorkerScriptAccordion(props: IProps): React.ReactElement { -  {numeralWrapper.formatExp(scriptRef.offlineExpGained) + " hacking exp"} +  {formatExp(scriptRef.offlineExpGained) + " hacking exp"} diff --git a/src/ui/CharacterStats.tsx b/src/ui/CharacterStats.tsx index cc9f63e13..68eecf604 100644 --- a/src/ui/CharacterStats.tsx +++ b/src/ui/CharacterStats.tsx @@ -10,7 +10,7 @@ import { Settings } from "../Settings/Settings"; import { MoneySourceTracker } from "../utils/MoneySourceTracker"; import { convertTimeMsToTimeElapsedString } from "../utils/StringHelperFunctions"; import { Player } from "@player"; -import { numeralWrapper } from "./numeralFormat"; +import { formatPercent } from "./formatNumber"; import { Modal } from "./React/Modal"; import { Money } from "./React/Money"; import { StatsRow } from "./React/StatsRow"; @@ -69,16 +69,13 @@ function MultiplierTable(props: MultTableProps): React.ReactElement { <> - {numeralWrapper.formatPercentage(value)}{" "} - {numeralWrapper.formatPercentage(effValue)} + {formatPercent(value)} {formatPercent(effValue)} ); } - return ( - - ); + return ; })} diff --git a/src/ui/React/CharacterOverview.tsx b/src/ui/React/CharacterOverview.tsx index ae01947c7..ebd7f7f0b 100644 --- a/src/ui/React/CharacterOverview.tsx +++ b/src/ui/React/CharacterOverview.tsx @@ -4,7 +4,7 @@ import React, { useMemo, useState, useEffect } from "react"; import { Theme, useTheme } from "@mui/material/styles"; import makeStyles from "@mui/styles/makeStyles"; import createStyles from "@mui/styles/createStyles"; -import { numeralWrapper } from "../numeralFormat"; +import { formatHp, formatMoney, formatSkill } from "../formatNumber"; import { Reputation } from "./Reputation"; import { KillScriptsModal } from "./KillScriptsModal"; import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; @@ -61,15 +61,15 @@ const valUpdaters: Record any> = { //These formattedVals functions don't take in a value because of the weirdness around HP. const formattedVals: Record string> = { - HP: () => `${numeralWrapper.formatHp(Player.hp.current)} / ${numeralWrapper.formatHp(Player.hp.max)}`, - Money: () => numeralWrapper.formatMoney(Player.money), - Hack: () => numeralWrapper.formatSkill(Player.skills.hacking), - Str: () => numeralWrapper.formatSkill(Player.skills.strength), - Def: () => numeralWrapper.formatSkill(Player.skills.defense), - Dex: () => numeralWrapper.formatSkill(Player.skills.dexterity), - Agi: () => numeralWrapper.formatSkill(Player.skills.agility), - Cha: () => numeralWrapper.formatSkill(Player.skills.charisma), - Int: () => numeralWrapper.formatSkill(Player.skills.intelligence), + HP: () => `${formatHp(Player.hp.current)} / ${formatHp(Player.hp.max)}`, + Money: () => formatMoney(Player.money), + Hack: () => formatSkill(Player.skills.hacking), + Str: () => formatSkill(Player.skills.strength), + Def: () => formatSkill(Player.skills.defense), + Dex: () => formatSkill(Player.skills.dexterity), + Agi: () => formatSkill(Player.skills.agility), + Cha: () => formatSkill(Player.skills.charisma), + Int: () => formatSkill(Player.skills.intelligence), }; const skillMultUpdaters: Record number> = { diff --git a/src/ui/React/Favor.tsx b/src/ui/React/Favor.tsx index da3805f8f..35c5912b5 100644 --- a/src/ui/React/Favor.tsx +++ b/src/ui/React/Favor.tsx @@ -1,5 +1,5 @@ import * as React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatFavor } from "../formatNumber"; import { Theme } from "@mui/material/styles"; import makeStyles from "@mui/styles/makeStyles"; import createStyles from "@mui/styles/createStyles"; @@ -14,5 +14,5 @@ const useStyles = makeStyles((theme: Theme) => export function Favor({ favor }: { favor: number | string }): React.ReactElement { const classes = useStyles(); - return {typeof favor === "number" ? numeralWrapper.formatFavor(favor) : favor}; + return {typeof favor === "number" ? formatFavor(favor) : favor}; } diff --git a/src/ui/React/HashRate.tsx b/src/ui/React/HashRate.tsx index 22990bfdf..d42790093 100644 --- a/src/ui/React/HashRate.tsx +++ b/src/ui/React/HashRate.tsx @@ -1,7 +1,7 @@ import React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatHashes } from "../formatNumber"; import { Hashes } from "./Hashes"; export function HashRate({ hashes }: { hashes: number }): React.ReactElement { - return ; + return ; } diff --git a/src/ui/React/Hashes.tsx b/src/ui/React/Hashes.tsx index dd364b429..04a403d0b 100644 --- a/src/ui/React/Hashes.tsx +++ b/src/ui/React/Hashes.tsx @@ -1,5 +1,5 @@ import * as React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatHashes } from "../formatNumber"; import { Theme } from "@mui/material/styles"; import makeStyles from "@mui/styles/makeStyles"; import createStyles from "@mui/styles/createStyles"; @@ -14,7 +14,5 @@ const useStyles = makeStyles((theme: Theme) => export function Hashes({ hashes }: { hashes: number | string }): React.ReactElement { const classes = useStyles(); - return ( - {typeof hashes === "number" ? numeralWrapper.formatHashes(hashes) : hashes} - ); + return {typeof hashes === "number" ? formatHashes(hashes) : hashes}; } diff --git a/src/ui/React/ImportSaveRoot.tsx b/src/ui/React/ImportSaveRoot.tsx index 51892d699..3487ba2ee 100644 --- a/src/ui/React/ImportSaveRoot.tsx +++ b/src/ui/React/ImportSaveRoot.tsx @@ -27,8 +27,8 @@ import WarningIcon from "@mui/icons-material/Warning"; import { ImportData, saveObject } from "../../SaveObject"; import { Settings } from "../../Settings/Settings"; -import { convertTimeMsToTimeElapsedString, formatNumber } from "../../utils/StringHelperFunctions"; -import { numeralWrapper } from "../numeralFormat"; +import { convertTimeMsToTimeElapsedString } from "../../utils/StringHelperFunctions"; +import { formatMoney, formatNumberNoSuffix } from "../formatNumber"; import { ConfirmationModal } from "./ConfirmationModal"; import { pushImportResult } from "../../Electron"; import { Router } from "../GameRoot"; @@ -231,8 +231,8 @@ export function ImportSaveRoot(props: IProps): JSX.Element { Money - {numeralWrapper.formatMoney(currentData.playerData?.money ?? 0)} - {numeralWrapper.formatMoney(importData.playerData?.money ?? 0)} + {formatMoney(currentData.playerData?.money ?? 0)} + {formatMoney(importData.playerData?.money ?? 0)} {importData.playerData?.money !== currentData.playerData?.money && ( Hacking - {formatNumber(currentData.playerData?.hacking ?? 0, 0)} - {formatNumber(importData.playerData?.hacking ?? 0, 0)} + {formatNumberNoSuffix(currentData.playerData?.hacking ?? 0, 0)} + {formatNumberNoSuffix(importData.playerData?.hacking ?? 0, 0)} {importData.playerData?.hacking !== currentData.playerData?.hacking && ( {numeralWrapper.formatMoney(props.money)}; + if (!Player.canAfford(props.money)) return {formatMoney(props.money)}; } return ( - - {typeof props.money === "number" ? numeralWrapper.formatMoney(props.money) : props.money} - + {typeof props.money === "number" ? formatMoney(props.money) : props.money} ); } diff --git a/src/ui/React/MoneyRate.tsx b/src/ui/React/MoneyRate.tsx index 00f658086..cae0693c2 100644 --- a/src/ui/React/MoneyRate.tsx +++ b/src/ui/React/MoneyRate.tsx @@ -1,7 +1,7 @@ import React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatMoney } from "../formatNumber"; import { Money } from "./Money"; export function MoneyRate({ money }: { money: number }): JSX.Element { - return ; + return ; } diff --git a/src/ui/React/NumberInput.tsx b/src/ui/React/NumberInput.tsx index cb0a41588..cc0248df2 100644 --- a/src/ui/React/NumberInput.tsx +++ b/src/ui/React/NumberInput.tsx @@ -1,6 +1,6 @@ import { TextField, StandardTextFieldProps } from "@mui/material"; import React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { parseBigNumber } from "../formatNumber"; interface IProps extends Omit { onChange: (v: number) => void; @@ -10,7 +10,7 @@ export function NumberInput(props: IProps): React.ReactElement { const textProps = { ...props, onChange: (event: React.ChangeEvent) => { - const amt = numeralWrapper.parseMoney(event.target.value); + const amt = parseBigNumber(event.target.value); if (event.target.value === "" || isNaN(amt)) props.onChange(NaN); else props.onChange(amt); }, diff --git a/src/ui/React/Reputation.tsx b/src/ui/React/Reputation.tsx index c9d6ad4d8..18ad9415f 100644 --- a/src/ui/React/Reputation.tsx +++ b/src/ui/React/Reputation.tsx @@ -1,5 +1,5 @@ import * as React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatReputation } from "../formatNumber"; import { Theme } from "@mui/material/styles"; import makeStyles from "@mui/styles/makeStyles"; import createStyles from "@mui/styles/createStyles"; @@ -16,7 +16,7 @@ export function Reputation({ reputation }: { reputation: number | string }): Rea const classes = useStyles(); return ( - {typeof reputation === "number" ? numeralWrapper.formatReputation(reputation) : reputation} + {typeof reputation === "number" ? formatReputation(reputation) : reputation} ); } diff --git a/src/ui/React/ReputationRate.tsx b/src/ui/React/ReputationRate.tsx index 21c0b3fb3..8562a7941 100644 --- a/src/ui/React/ReputationRate.tsx +++ b/src/ui/React/ReputationRate.tsx @@ -1,7 +1,7 @@ import React from "react"; -import { numeralWrapper } from "../numeralFormat"; +import { formatReputation } from "../formatNumber"; import { Reputation } from "./Reputation"; export function ReputationRate({ reputation }: { reputation: number }): React.ReactElement { - return ; + return ; } diff --git a/src/ui/React/StatsProgressBar.tsx b/src/ui/React/StatsProgressBar.tsx index 50e3ecdbc..727f156ee 100644 --- a/src/ui/React/StatsProgressBar.tsx +++ b/src/ui/React/StatsProgressBar.tsx @@ -3,7 +3,7 @@ import LinearProgress from "@mui/material/LinearProgress"; import { TableCell, Tooltip, Typography } from "@mui/material"; import { characterOverviewStyles } from "./CharacterOverview"; import { ISkillProgress } from "src/PersonObjects/formulas/skill"; -import { numeralWrapper } from "../numeralFormat"; +import { formatExp } from "../formatNumber"; interface IProgressProps { min: number; @@ -30,10 +30,10 @@ export function StatsProgressBar({ const tooltip = ( Progress:  - {numeralWrapper.formatExp(current)} / {numeralWrapper.formatExp(max - min)} + {formatExp(current)} / {formatExp(max - min)}
Remaining:  - {numeralWrapper.formatExp(remaining)} ({progress.toFixed(2)}%) + {formatExp(remaining)} ({progress.toFixed(2)}%) ); diff --git a/src/ui/React/StatsRow.tsx b/src/ui/React/StatsRow.tsx index 279758e30..3818f4e9b 100644 --- a/src/ui/React/StatsRow.tsx +++ b/src/ui/React/StatsRow.tsx @@ -2,8 +2,7 @@ import React from "react"; import { Typography, TableCell, TableRow } from "@mui/material"; -import { numeralWrapper } from "../numeralFormat"; -import { formatNumber } from "../../utils/StringHelperFunctions"; +import { formatExp, formatNumberNoSuffix } from "../formatNumber"; import { characterOverviewStyles as useStyles } from "./CharacterOverview"; import { ClassNameMap } from "@material-ui/core/styles/withStyles"; @@ -28,9 +27,9 @@ export const StatsRow = ({ name, color, classes = useStyles(), children, data }: if (data.content !== undefined) { content = data.content; } else if (data.level !== undefined && data.exp !== undefined) { - content = `${formatNumber(data.level, 0)} (${numeralWrapper.formatExp(data.exp)} exp)`; + content = `${formatNumberNoSuffix(data.level, 0)} (${formatExp(data.exp)} exp)`; } else if (data.level !== undefined && data.exp === undefined) { - content = `${formatNumber(data.level, 0)}`; + content = `${formatNumberNoSuffix(data.level, 0)}`; } } diff --git a/src/ui/WorkInProgressRoot.tsx b/src/ui/WorkInProgressRoot.tsx index 45efd4946..22e95377f 100644 --- a/src/ui/WorkInProgressRoot.tsx +++ b/src/ui/WorkInProgressRoot.tsx @@ -12,7 +12,7 @@ import { convertTimeMsToTimeElapsedString } from "../utils/StringHelperFunctions import { Player } from "@player"; import { Router } from "./GameRoot"; import { Page } from "./Router"; -import { numeralWrapper } from "./numeralFormat"; +import { formatExp, formatPercent } from "./formatNumber"; import { Money } from "./React/Money"; import { MoneyRate } from "./React/MoneyRate"; import { ProgressBar } from "./React/Progress"; @@ -56,7 +56,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Hacking Exp" color={Settings.theme.hack} data={{ - content: `${numeralWrapper.formatExp(rate.hackExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.hackExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -67,7 +67,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Strength Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.strExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.strExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -78,7 +78,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Defense Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.defExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.defExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -89,7 +89,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Dexterity Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.dexExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.dexExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -100,7 +100,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Agility Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.agiExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.agiExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -111,7 +111,7 @@ function ExpRows(rate: WorkStats): React.ReactElement[] { name="Charisma Exp" color={Settings.theme.cha} data={{ - content: `${numeralWrapper.formatExp(rate.chaExp * CYCLES_PER_SEC)} / sec`, + content: `${formatExp(rate.chaExp * CYCLES_PER_SEC)} / sec`, }} /> ) : ( @@ -128,7 +128,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Hacking Exp" color={Settings.theme.hack} data={{ - content: `${numeralWrapper.formatExp(rate.hackExp)}`, + content: `${formatExp(rate.hackExp)}`, }} /> ) : ( @@ -139,7 +139,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Strength Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.strExp)}`, + content: `${formatExp(rate.strExp)}`, }} /> ) : ( @@ -150,7 +150,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Defense Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.defExp)}`, + content: `${formatExp(rate.defExp)}`, }} /> ) : ( @@ -161,7 +161,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Dexterity Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.dexExp)}`, + content: `${formatExp(rate.dexExp)}`, }} /> ) : ( @@ -172,7 +172,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Agility Exp" color={Settings.theme.combat} data={{ - content: `${numeralWrapper.formatExp(rate.agiExp)}`, + content: `${formatExp(rate.agiExp)}`, }} /> ) : ( @@ -183,7 +183,7 @@ function CrimeExpRows(rate: WorkStats): React.ReactElement[] { name="Charisma Exp" color={Settings.theme.cha} data={{ - content: `${numeralWrapper.formatExp(rate.chaExp)}`, + content: `${formatExp(rate.chaExp)}`, }} /> ) : ( @@ -235,7 +235,7 @@ export function WorkInProgressRoot(): React.ReactElement { title: `You are attempting ${crime.workName}`, gains: [ - Success chance: {numeralWrapper.formatPercentage(successChance)}, + Success chance: {formatPercent(successChance)}, Gains (on success), diff --git a/src/ui/formatNumber.ts b/src/ui/formatNumber.ts new file mode 100644 index 000000000..19f9c1d2c --- /dev/null +++ b/src/ui/formatNumber.ts @@ -0,0 +1,198 @@ +import { ThemeEvents } from "../Themes/ui/Theme"; +import { EventEmitter } from "../utils/EventEmitter"; +import { Settings } from "../Settings/Settings"; + +const numberSuffixList = ["", "k", "m", "b", "t", "q", "Q", "s", "S", "o", "n"]; +// exponents associated with each suffix +const numberExpList = numberSuffixList.map((_, i) => parseFloat(`1e${i * 3}`)); + +// Ram suffixes +const ramLog1000Suffixes = ["GB", "TB", "PB", "EB"]; +const ramLog1024Suffixes = ["GiB", "TiB", "PiB", "EiB"]; + +// Items that get initialized in the initializer function. +let digitFormats = {} as Record, + percentFormats = {} as Record, + basicFormatter: Intl.NumberFormat, + exponentialFormatter: Intl.NumberFormat, + ramSuffixList: string[], + ramExpList: number[], + ramLogFn: (n: number) => number, + ramLogDivisor: number; + +/** Event to be emitted when changing number display settings. */ +export const FormatsNeedToChange = new EventEmitter(); + +/** Event to be emitted after the cached formatters are cleared. */ +export const FormatsHaveChanged = new EventEmitter(); + +// Initialization function +FormatsNeedToChange.subscribe(() => { + // Clear all cached formatters + digitFormats = {}; + percentFormats = {}; + exponentialFormatter = makeFormatter(3, { notation: Settings.useEngineeringNotation ? "engineering" : "scientific" }); + basicFormatter = new Intl.NumberFormat([Settings.Locale, "en"], { useGrouping: !Settings.hideThousandsSeparator }); + [ramSuffixList, ramLogFn, ramLogDivisor] = Settings.UseIEC60027_2 + ? // log2 of 1024 is 10 as divisor for log base 1024 + [ramLog1024Suffixes, Math.log2, 10] + : // log10 of 1000 is 3 as divisor for log base 1000 + [ramLog1000Suffixes, Math.log10, 3]; + ramExpList = ramSuffixList.map((_, i) => (Settings.UseIEC60027_2 ? 1024 : 1000) ** i); + + // Emit a FormatsHaveChanged event so any static content that uses formats can be regenerated. + FormatsHaveChanged.emit(); + // Force a redraw of the entire UI + ThemeEvents.emit(); +}); + +/** Makes a new formatter */ +function makeFormatter(fractionalDigits: number, otherOptions: Intl.NumberFormatOptions = {}): Intl.NumberFormat { + if (Settings.hideThousandsSeparator) otherOptions.useGrouping = false; + return new Intl.NumberFormat([Settings.Locale, "en"], { + minimumFractionDigits: Settings.hideTrailingDecimalZeros ? 0 : fractionalDigits, + maximumFractionDigits: fractionalDigits, + ...otherOptions, + }); +} +/** Returns a cached formatter if it already exists, otherwise makes and returns a new formatter */ +function getFormatter( + fractionalDigits: number, + formatList = digitFormats, + options: Intl.NumberFormatOptions = {}, +): Intl.NumberFormat { + if (formatList[fractionalDigits]) return formatList[fractionalDigits] as Intl.NumberFormat; + return (formatList[fractionalDigits] = makeFormatter(fractionalDigits, options)); +} + +/** Display standard ram formatting. */ +export function formatRam(n: number, fractionalDigits = 2) { + // NaN does not get formatted + if (Number.isNaN(n)) return `NaN${ramSuffixList[0]}`; + const nAbs = Math.abs(n); + + // Special handling for Infinities + if (nAbs === Infinity) return `${n < 0 ? "-∞" : ""}∞${ramSuffixList.at(-1)}`; + + // Ram always uses a suffix and never goes to exponential + const suffixIndex = Math.min(Math.floor(ramLogFn(nAbs) / ramLogDivisor), ramSuffixList.length - 1); + n /= ramExpList[suffixIndex]; + /* Not really concerned with 1000-rounding or 1024-rounding for ram due to the actual values ram gets displayed at. + If display of e.g. 1,000.00GB instead of 1.00TB for 999.995GB, or 1,024.00GiB instead of 1.00TiB for 1,023.995GiB + becomes an actual issue we can add smart rounding, but ram values like that really don't happen ingame so it's + probably not worth the performance overhead to check and correct these. */ + return getFormatter(fractionalDigits).format(n) + ramSuffixList[suffixIndex]; +} + +function formatExponential(n: number) { + return exponentialFormatter.format(n).toLocaleLowerCase(); +} + +export function formatPercent(n: number, fractionalDigits = 2) { + // NaN does not get formatted + if (Number.isNaN(n)) return "NaN%"; + const nAbs = Math.abs(n); + + // Special handling for Infinities + if (nAbs === Infinity) return n < 0 ? "-∞%" : "∞%"; + + return getFormatter(fractionalDigits, percentFormats, { style: "percent" }).format(n); +} + +// formatNumber doesn't accept ram as a special flag, that is only used for ns.formatNumber which will use formatRam +export function formatNumber(n: number, fractionalDigits = 3, suffixStart = 1000, isInteger = false) { + // NaN does not get formatted + if (Number.isNaN(n)) return "NaN"; + const nAbs = Math.abs(n); + + // Special handling for Infinities + if (nAbs === Infinity) return n < 0 ? "-∞" : "∞"; + + // Early return for non-suffix + if (nAbs < suffixStart) { + if (isInteger) return basicFormatter.format(n); + return getFormatter(fractionalDigits).format(n); + } + + // Exponential form + if (Settings.disableSuffixes || nAbs >= 1e33) return formatExponential(n); + + // Calculate suffix index. 1000 = 10^3 + let suffixIndex = Math.floor(Math.log10(nAbs) / 3); + + n /= numberExpList[suffixIndex]; + // Todo: Find a better way to detect if number is rounding to 1000${suffix}, or find a simple way to truncate to x digits instead of rounding + // Detect if number rounds to 1000.000 (based on number of digits given) + if (Math.abs(n).toFixed(fractionalDigits).length === fractionalDigits + 5 && numberSuffixList[suffixIndex + 1]) { + suffixIndex += 1; + n = n < 0 ? -1 : 1; + } + return getFormatter(fractionalDigits).format(n) + numberSuffixList[suffixIndex]; +} + +/** Format a number without suffixes. Still show exponential form if >= 1e33. */ +export const formatNumberNoSuffix = (n: number, fractionalDigits = 0) => { + return formatNumber(n, fractionalDigits, 1e33); +}; +export const formatFavor = formatNumberNoSuffix; + +/** Standard noninteger formatting with no options set. Collapses to suffix at 1000 and shows 3 fractional digits. */ +export const formatBigNumber = (n: number) => formatNumber(n); +export const formatExp = formatBigNumber; +export const formatHashes = formatBigNumber; +export const formatReputation = formatBigNumber; +export const formatPopulation = formatBigNumber; +export const formatSecurity = formatBigNumber; +export const formatStamina = formatBigNumber; +export const formatStaneksGiftCharge = formatBigNumber; + +/** Format a number with suffixes starting at 1000 and 2 fractional digits */ +export const formatQuality = (n: number) => formatNumber(n, 2); + +/** Format an integer that uses suffixed form at 1000 and 3 fractional digits. */ +export const formatInt = (n: number) => formatNumber(n, 3, 1000, true); +export const formatSleeveMemory = formatInt; +export const formatShares = formatInt; + +/** Display an integer up to 999,999 before collapsing to suffixed form with 3 fractional digits */ +export const formatHp = (n: number) => formatNumber(n, 3, 1e6, true); +export const formatThreads = formatHp; + +/** Display an integer up to 999,999,999 before collapsing to suffixed form with 3 fractional digits */ +export const formatSkill = (n: number) => formatNumber(n, 3, 1e9, true); + +/** Display standard money formatting, including the preceding $. */ +export const formatMoney = (n: number) => "$" + formatNumber(n); + +/** Display a decimal number with increased precision (5 fractional digits) */ +export const formatRespect = (n: number) => formatNumber(n, 5); +export const formatWanted = formatRespect; +export const formatPreciseMultiplier = formatRespect; + +/** Format a number with no suffix and 1 fractional digit. */ +export const formatMaterialSize = (n: number) => formatNumberNoSuffix(n, 1); + +/** Format a number with no suffix and 2 fractional digits. */ +export const formatMultiplier = (n: number) => formatNumberNoSuffix(n, 2); +export const formatStaneksGiftPower = formatMultiplier; +export const formatMatPurchaseAmount = formatMultiplier; + +/** Format a number with no suffix and 3 fractional digits. */ +export const formatSleeveShock = (n: number) => formatNumberNoSuffix(n, 3); +export const formatSleeveSynchro = formatSleeveShock; +export const formatCorpStat = formatSleeveShock; + +/** Parsing numbers does not use the locale as this causes complications. */ +export function parseBigNumber(str: string): number { + str = str.trim(); + // Remove all commas in case the player is typing a longform number + str = str.replace(/,/g, ""); + // Handle special returns + if (["infinity", "Infinity", "∞"].includes(str)) return Infinity; + if (["-infinity", "-Infinity", "-∞"].includes(str)) return -Infinity; + + const suffixIndex = numberSuffixList.indexOf(str.substring(str.length - 1)); + // If there's no valid suffix at the end, just return parseFloated string + if (suffixIndex === -1) return parseFloat(str); + return parseFloat(str.substring(0, str.length - 1) + "e" + suffixIndex * 3); +} diff --git a/src/ui/numeralFormat.ts b/src/ui/numeralFormat.ts deleted file mode 100644 index 04ec612e0..000000000 --- a/src/ui/numeralFormat.ts +++ /dev/null @@ -1,256 +0,0 @@ -import numeral from "numeral"; -import "numeral/locales/bg"; -import "numeral/locales/cs"; -import "numeral/locales/da-dk"; -import "numeral/locales/de"; -import "numeral/locales/en-au"; -import "numeral/locales/en-gb"; -import "numeral/locales/es"; -import "numeral/locales/fr"; -import "numeral/locales/hu"; -import "numeral/locales/it"; -import "numeral/locales/lv"; -import "numeral/locales/no"; -import "numeral/locales/pl"; -import "numeral/locales/ru"; - -import { Settings } from "../Settings/Settings"; - -const extraFormats = [1e15, 1e18, 1e21, 1e24, 1e27, 1e30]; -const extraNotations = ["q", "Q", "s", "S", "o", "n"]; -const gigaMultiplier = { standard: 1e9, iec60027_2: 2 ** 30 }; - -class NumeralFormatter { - // Default Locale - defaultLocale = "en"; - - constructor() { - this.defaultLocale = "en"; - } - - updateLocale(l: string): boolean { - if (numeral.locale(l) == null) { - console.warn(`Invalid locale for numeral: ${l}`); - - numeral.locale(this.defaultLocale); - return false; - } - return true; - } - - format(n: number | string, format?: string): string { - // numeral.js doesn't properly format numbers that are too big or too small - if (Math.abs(n as number) < 1e-6) { - n = 0; - } - const answer = numeral(n).format(format); - if (answer === "NaN") { - return `${n}`; - } - return answer; - } - - formatBigNumber(n: number | string): string { - return this.format(n, "0.000a"); - } - - // TODO: leverage numeral.js to do it. This function also implies you can - // use this format in some text field but you can't. ( "1t" will parse but - // "1s" will not) - formatReallyBigNumber(n: number | string, decimalPlaces = 3): string { - const nAbs = Math.abs(n as number); - if (n === Infinity) return "∞"; - for (let i = 0; i < extraFormats.length; i++) { - if (extraFormats[i] <= nAbs && nAbs < extraFormats[i] * 1000) { - return this.format((n as number) / extraFormats[i], "0." + "0".repeat(decimalPlaces)) + extraNotations[i]; - } - } - if (nAbs < 1000) { - return this.format(n, "0." + "0".repeat(decimalPlaces)); - } - const str = this.format(n, "0." + "0".repeat(decimalPlaces) + "a"); - if (str === "NaNt") return this.format(n, "0." + " ".repeat(decimalPlaces) + "e+0"); - return str; - } - - formatHp(n: number): string { - if (n < 1e6) { - return this.format(n, "0,0"); - } - return this.formatReallyBigNumber(n); - } - - formatMoney(n: number): string { - return "$" + this.formatReallyBigNumber(n); - } - - formatSkill(n: number): string { - if (n < 1e15) { - return this.format(n, "0,0"); - } - return this.formatReallyBigNumber(n); - } - - formatExp(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatHashes(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatReputation(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatFavor(n: number): string { - return this.format(n, "0,0"); - } - - formatSecurity(n: number): string { - return n.toFixed(3); - } - - formatRAM(n: number): string { - if (Settings.UseIEC60027_2) { - return this.format(n * gigaMultiplier.iec60027_2, "0.00ib"); - } - return this.format(n * gigaMultiplier.standard, "0.00b"); - } - - formatPercentage(n: number | string, decimalPlaces = 2): string { - const formatter: string = "0." + "0".repeat(decimalPlaces) + "%"; - return this.format(n, formatter); - } - - formatServerSecurity(n: number): string { - return this.format(n, "0,0.000"); - } - - formatRespect(n: number): string { - return this.formatReallyBigNumber(n, 5); - } - - formatWanted(n: number): string { - return this.formatReallyBigNumber(n, 5); - } - - formatMultiplier(n: number): string { - return this.format(n, "0,0.00"); - } - - formatSleeveShock(n: number): string { - return this.format(n, "0,0.000"); - } - - formatSleeveSynchro(n: number): string { - return this.format(n, "0,0.000"); - } - - formatSleeveMemory(n: number): string { - return this.format(n, "0"); - } - - formatPopulation(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatStamina(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatShares(n: number): string { - if (n < 1000) { - return this.format(n, "0"); - } - return this.formatReallyBigNumber(n); - } - - formatInfiltrationSecurity(n: number): string { - return this.formatReallyBigNumber(n); - } - - formatThreads(n: number): string { - return this.format(n, "0,0"); - } - - formatStaneksGiftHeat(n: number): string { - return this.format(n, "0.000a"); - } - - formatStaneksGiftCharge(n: number): string { - return this.format(n, "0.000a"); - } - - formatStaneksGiftPower(n: number): string { - return this.format(n, "0.00"); - } - - parseCustomLargeNumber(str: string): number { - const numericRegExp = new RegExp("^(-?\\d+\\.?\\d*)([" + extraNotations.join("") + "]?)$"); - const match = str.match(numericRegExp); - if (match == null) { - return NaN; - } - const [, number, notation] = match; - const notationIndex = extraNotations.indexOf(notation); - if (notationIndex === -1) { - return NaN; - } - return parseFloat(number) * extraFormats[notationIndex]; - } - - largestAbsoluteNumber(n1: number, n2 = 0, n3 = 0): number { - if (isNaN(n1)) n1 = 0; - if (isNaN(n2)) n2 = 0; - if (isNaN(n3)) n3 = 0; - const largestAbsolute = Math.max(Math.abs(n1), Math.abs(n2), Math.abs(n3)); - switch (largestAbsolute) { - case Math.abs(n1): - return n1; - case Math.abs(n2): - return n2; - case Math.abs(n3): - return n3; - } - return 0; - } - - parseMoney(s: string): number { - // numeral library does not handle formats like 1s (returns 1) and 1e10 (returns 110) well, - // so if more then 1 return a valid number, return the one farthest from 0 - const numeralValue = numeral(s).value(); - const parsed = parseFloat(s); - const selfParsed = this.parseCustomLargeNumber(s); - // Check for one or more NaN values - if (isNaN(parsed) && isNaN(selfParsed)) { - if (numeralValue === null) { - // 3x NaN - return NaN; - } - // 2x NaN - return numeralValue; - } else if (numeralValue === null && isNaN(selfParsed)) { - // 2x NaN - return parsed; - } else if (isNaN(parsed)) { - if (numeralValue === null) { - // 2x NaN - return selfParsed; - } - // 1x NaN - return this.largestAbsoluteNumber(numeralValue, selfParsed); - } else if (numeralValue === null) { - // 1x NaN - return this.largestAbsoluteNumber(parsed, selfParsed); - } else if (isNaN(selfParsed)) { - // 1x NaN - return this.largestAbsoluteNumber(numeralValue, parsed); - } else { - // no NaN - return this.largestAbsoluteNumber(numeralValue, parsed, selfParsed); - } - } -} - -export const numeralWrapper = new NumeralFormatter(); diff --git a/src/utils/StringHelperFunctions.ts b/src/utils/StringHelperFunctions.ts index 8417dc032..d848d8809 100644 --- a/src/utils/StringHelperFunctions.ts +++ b/src/utils/StringHelperFunctions.ts @@ -78,14 +78,6 @@ function containsAllStrings(arr: string[]): boolean { return arr.every(isString); } -// Formats a number with commas and a specific number of decimal digits -function formatNumber(num: number, numFractionDigits = 0): string { - return num.toLocaleString(undefined, { - maximumFractionDigits: numFractionDigits, - minimumFractionDigits: numFractionDigits, - }); -} - // Generates a random alphanumeric string with N characters function generateRandomString(n: number): string { let str = ""; @@ -133,7 +125,6 @@ export { convertTimeMsToTimeElapsedString, longestCommonStart, containsAllStrings, - formatNumber, generateRandomString, cyrb53, capitalizeFirstLetter, diff --git a/test/jest/ui/formatNumber.test.ts b/test/jest/ui/formatNumber.test.ts new file mode 100644 index 000000000..e801e34a4 --- /dev/null +++ b/test/jest/ui/formatNumber.test.ts @@ -0,0 +1,212 @@ +import { Settings } from "../../../src/Settings/Settings"; +import { + formatBigNumber, + formatPercent, + parseBigNumber, + FormatsNeedToChange, + formatNumber, + formatRam, +} from "../../../src/ui/formatNumber"; + +describe("Suffix rounding test", () => { + test("Rounding Test", () => { + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + expect(formatNumber(0.99999999e12)).toEqual("1.000t"); + expect(formatNumber(-0.99999999e12)).toEqual("-1.000t"); + }); +}); + +describe("Numeral formatting for positive numbers", () => { + test("should not format too small numbers and should hide trailing zeroes if configured", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = true; + FormatsNeedToChange.emit(); + expect(formatNumber(0.0000000001, 6)).toEqual("0"); + expect(formatNumber(0.000000001, 6)).toEqual("0"); + expect(formatNumber(0.00000001, 6)).toEqual("0"); + expect(formatNumber(0.0000001, 6)).toEqual("0"); + expect(formatNumber(0.000001, 6)).toEqual("0.000001"); + expect(formatNumber(0.00001, 6)).toEqual("0.00001"); + expect(formatNumber(0.0001, 6)).toEqual("0.0001"); + expect(formatNumber(0.001, 6)).toEqual("0.001"); + expect(formatNumber(0.01, 6)).toEqual("0.01"); + expect(formatNumber(0.1, 6)).toEqual("0.1"); + expect(formatNumber(1, 6)).toEqual("1"); + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + }); + test("powers of 10 test for suffix form", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + const suffixes = ["", "k", "m", "b", "t", "q", "Q", "s", "S", "o", "n"]; + for (let i = 0; i < suffixes.length; i++) { + expect(formatNumber(parseFloat("1e" + i * 3))).toEqual("1.000" + suffixes[i]); + expect(formatNumber(parseFloat("1e" + (i * 3 + 1)))).toEqual("10.000" + suffixes[i]); + expect(formatNumber(parseFloat("1e" + (i * 3 + 2)))).toEqual("100.000" + suffixes[i]); + } + }); + test("should format really big numbers in readable format", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + expect(formatBigNumber(987)).toEqual("987.000"); + expect(formatBigNumber(987654)).toEqual("987.654k"); + expect(formatBigNumber(987654321)).toEqual("987.654m"); + expect(formatBigNumber(987654321987)).toEqual("987.654b"); + expect(formatBigNumber(987654321987654)).toEqual("987.654t"); + expect(formatBigNumber(987654321987654e3)).toEqual("987.654q"); + expect(formatBigNumber(987654321987654e6)).toEqual("987.654Q"); + expect(formatBigNumber(987654321987654e9)).toEqual("987.654s"); + expect(formatBigNumber(987654321987654e12)).toEqual("987.654S"); + expect(formatBigNumber(987654321987654e15)).toEqual("987.654o"); + expect(formatBigNumber(987654321987654e18)).toEqual("987.654n"); + }); + test("should format even bigger really big numbers in scientific format", () => { + expect(formatBigNumber(987654321987654e21)).toEqual("9.877e35"); + expect(formatBigNumber(987654321987654e22)).toEqual("9.877e36"); + expect(formatBigNumber(987654321987654e23)).toEqual("9.877e37"); + }); + test("should format percentage", () => { + expect(formatPercent(1234.56789)).toEqual("123,456.79%"); + }); +}); + +describe("Numeral formatting for negative numbers", () => { + test("should not format too small numbers and should hide trailing zeroes if configured", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = true; + FormatsNeedToChange.emit(); + // No simple way right now to force 0 instead of -0 + expect(formatNumber(-0.0000000001, 6)).toEqual("-0"); + expect(formatNumber(-0.000000001, 6)).toEqual("-0"); + expect(formatNumber(-0.00000001, 6)).toEqual("-0"); + expect(formatNumber(-0.0000001, 6)).toEqual("-0"); + expect(formatNumber(-0.000001, 6)).toEqual("-0.000001"); + expect(formatNumber(-0.00001, 6)).toEqual("-0.00001"); + expect(formatNumber(-0.0001, 6)).toEqual("-0.0001"); + expect(formatNumber(-0.001, 6)).toEqual("-0.001"); + expect(formatNumber(-0.01, 6)).toEqual("-0.01"); + expect(formatNumber(-0.1, 6)).toEqual("-0.1"); + expect(formatNumber(-1, 6)).toEqual("-1"); + }); + test("powers of 10 test for suffix form", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + const suffixes = ["", "k", "m", "b", "t", "q", "Q", "s", "S", "o", "n"]; + for (let i = 0; i < suffixes.length; i++) { + expect(formatNumber(parseFloat("-1e" + i * 3))).toEqual("-1.000" + suffixes[i]); + expect(formatNumber(parseFloat("-1e" + (i * 3 + 1)))).toEqual("-10.000" + suffixes[i]); + expect(formatNumber(parseFloat("-1e" + (i * 3 + 2)))).toEqual("-100.000" + suffixes[i]); + } + }); + test("should format really big numbers in readable format", () => { + // Initial settings + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + expect(formatBigNumber(-987)).toEqual("-987.000"); + expect(formatBigNumber(-987654)).toEqual("-987.654k"); + expect(formatBigNumber(-987654321)).toEqual("-987.654m"); + expect(formatBigNumber(-987654321987)).toEqual("-987.654b"); + expect(formatBigNumber(-987654321987654)).toEqual("-987.654t"); + expect(formatBigNumber(-987654321987654e3)).toEqual("-987.654q"); + expect(formatBigNumber(-987654321987654e6)).toEqual("-987.654Q"); + expect(formatBigNumber(-987654321987654e9)).toEqual("-987.654s"); + expect(formatBigNumber(-987654321987654e12)).toEqual("-987.654S"); + expect(formatBigNumber(-987654321987654e15)).toEqual("-987.654o"); + expect(formatBigNumber(-987654321987654e18)).toEqual("-987.654n"); + }); + test("should format even bigger really big numbers in scientific format", () => { + expect(formatBigNumber(-987654321987654e21)).toEqual("-9.877e35"); + expect(formatBigNumber(-987654321987654e22)).toEqual("-9.877e36"); + expect(formatBigNumber(-987654321987654e23)).toEqual("-9.877e37"); + }); + test("should format percentage", () => { + expect(formatPercent(-1234.56789)).toEqual("-123,456.79%"); + }); +}); + +describe("Numeral formatting of scientific text", () => { + test("Parsing positive numbers", () => { + // Accepted by numeral.js + expect(parseBigNumber("123")).toEqual(123); + expect(parseBigNumber("123.456")).toEqual(123.456); + expect(parseBigNumber("123k")).toEqual(123e3); + expect(parseBigNumber("123.456k")).toEqual(123456); + expect(parseBigNumber("123m")).toEqual(123e6); + expect(parseBigNumber("123.456m")).toEqual(123456e3); + expect(parseBigNumber("123b")).toEqual(123e9); + expect(parseBigNumber("123.456b")).toEqual(123456e6); + expect(parseBigNumber("123t")).toEqual(123e12); + expect(parseBigNumber("123.456t")).toEqual(123456e9); + expect(parseBigNumber("123q")).toEqual(123e15); + expect(parseBigNumber("123.456q")).toEqual(123456e12); + expect(parseBigNumber("123Q")).toEqual(123e18); + expect(parseBigNumber("123.456Q")).toEqual(123456e15); + expect(parseBigNumber("123s")).toEqual(123e21); + expect(parseBigNumber("123.456s")).toEqual(123456e18); + expect(parseBigNumber("123S")).toEqual(123e24); + expect(parseBigNumber("123.456S")).toEqual(123456e21); + expect(parseBigNumber("123o")).toEqual(123e27); + expect(parseBigNumber("123.456o")).toEqual(123456e24); + expect(parseBigNumber("123n")).toEqual(123e30); + expect(parseBigNumber("123.456n")).toEqual(123456e27); + }); + test("Parsing negative numbers", () => { + // Accepted by numeral.js + expect(parseBigNumber("-123")).toEqual(-123); + expect(parseBigNumber("-123.456")).toEqual(-123.456); + expect(parseBigNumber("-123k")).toEqual(-123e3); + expect(parseBigNumber("-123.456k")).toEqual(-123456); + expect(parseBigNumber("-123m")).toEqual(-123e6); + expect(parseBigNumber("-123.456m")).toEqual(-123456e3); + expect(parseBigNumber("-123b")).toEqual(-123e9); + expect(parseBigNumber("-123.456b")).toEqual(-123456e6); + expect(parseBigNumber("-123t")).toEqual(-123e12); + expect(parseBigNumber("-123.456t")).toEqual(-123456e9); + expect(parseBigNumber("-123q")).toEqual(-123e15); + expect(parseBigNumber("-123.456q")).toEqual(-123456e12); + expect(parseBigNumber("-123Q")).toEqual(-123e18); + expect(parseBigNumber("-123.456Q")).toEqual(-123456e15); + expect(parseBigNumber("-123s")).toEqual(-123e21); + expect(parseBigNumber("-123.456s")).toEqual(-123456e18); + expect(parseBigNumber("-123S")).toEqual(-123e24); + expect(parseBigNumber("-123.456S")).toEqual(-123456e21); + expect(parseBigNumber("-123o")).toEqual(-123e27); + expect(parseBigNumber("-123.456o")).toEqual(-123456e24); + expect(parseBigNumber("-123n")).toEqual(-123e30); + expect(parseBigNumber("-123.456n")).toEqual(-123456e27); + }); +}); +describe("Ram formatting", () => { + test("With default GB mode", () => { + // Initial settings + Settings.UseIEC60027_2 = false; + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + // Base unit for ram is GB. + expect(formatRam(1)).toEqual("1.00GB"); + expect(formatRam(1e3)).toEqual("1.00TB"); + expect(formatRam(1024)).toEqual("1.02TB"); + expect(formatRam(1e6)).toEqual("1.00PB"); + expect(formatRam(1048576)).toEqual("1.05PB"); + expect(formatRam(1e9)).toEqual("1.00EB"); + expect(formatRam(1073741824)).toEqual("1.07EB"); + }); + test("With GiB mode", () => { + // Initial settings + Settings.UseIEC60027_2 = true; + Settings.hideTrailingDecimalZeros = false; + FormatsNeedToChange.emit(); + // Base unit for ram is now GiB. + expect(formatRam(1)).toEqual("1.00GiB"); + expect(formatRam(1e3)).toEqual("1,000.00GiB"); + expect(formatRam(1024)).toEqual("1.00TiB"); + expect(formatRam(1e6)).toEqual("976.56TiB"); + expect(formatRam(1048576)).toEqual("1.00PiB"); + expect(formatRam(1e9)).toEqual("953.67PiB"); + expect(formatRam(1073741824)).toEqual("1.00EiB"); + }); +}); diff --git a/test/jest/ui/nFormat.test.ts b/test/jest/ui/nFormat.test.ts deleted file mode 100644 index a66c70399..000000000 --- a/test/jest/ui/nFormat.test.ts +++ /dev/null @@ -1,248 +0,0 @@ -import { numeralWrapper } from "../../../src/ui/numeralFormat"; - -const decimalFormat = "0.[000000]"; - -describe("Numeral formatting for positive numbers", () => { - test("should not format too small numbers", () => { - expect(numeralWrapper.format(0.0000000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(0.000000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(0.00000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(0.0000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(0.000001, decimalFormat)).toEqual("0.000001"); - expect(numeralWrapper.format(0.00001, decimalFormat)).toEqual("0.00001"); - expect(numeralWrapper.format(0.0001, decimalFormat)).toEqual("0.0001"); - expect(numeralWrapper.format(0.001, decimalFormat)).toEqual("0.001"); - expect(numeralWrapper.format(0.01, decimalFormat)).toEqual("0.01"); - expect(numeralWrapper.format(0.1, decimalFormat)).toEqual("0.1"); - expect(numeralWrapper.format(1, decimalFormat)).toEqual("1"); - }); - test("should format big numbers in short format", () => { - expect(numeralWrapper.formatBigNumber(987654000000000000)).toEqual("987654.000t"); - expect(numeralWrapper.formatBigNumber(987654300000000000)).toEqual("987654.300t"); - expect(numeralWrapper.formatBigNumber(987654320000000000)).toEqual("987654.320t"); - expect(numeralWrapper.formatBigNumber(987654321000000000)).toEqual("987654.321t"); - expect(numeralWrapper.formatBigNumber(987654321900000000)).toEqual("987654.322t"); - }); - test("should format really big numbers in readable format", () => { - expect(numeralWrapper.formatReallyBigNumber(987)).toEqual("987.000"); - expect(numeralWrapper.formatReallyBigNumber(987654)).toEqual("987.654k"); - expect(numeralWrapper.formatReallyBigNumber(987654321)).toEqual("987.654m"); - expect(numeralWrapper.formatReallyBigNumber(987654321987)).toEqual("987.654b"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654)).toEqual("987.654t"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000)).toEqual("987.654q"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000)).toEqual("987.654Q"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000000)).toEqual("987.654s"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000000000)).toEqual("987.654S"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000000000000)).toEqual("987.654o"); - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000000000000000)).toEqual("987.654n"); - }); - test("should format even bigger really big numbers in scientific format", () => { - expect(numeralWrapper.formatReallyBigNumber(987654321987654000000000000000000000)).toEqual("9.877e+35"); - expect(numeralWrapper.formatReallyBigNumber(9876543219876540000000000000000000000)).toEqual("9.877e+36"); - expect(numeralWrapper.formatReallyBigNumber(98765432198765400000000000000000000000)).toEqual("9.877e+37"); - }); - test("should format percentage", () => { - expect(numeralWrapper.formatPercentage(1234.56789)).toEqual("123456.79%"); - }); -}); - -describe("Numeral formatting for negative numbers", () => { - test("should not format too small numbers", () => { - expect(numeralWrapper.format(-0.0000000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(-0.000000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(-0.00000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(-0.0000001, decimalFormat)).toEqual("0"); - expect(numeralWrapper.format(-0.000001, decimalFormat)).toEqual("-0.000001"); - expect(numeralWrapper.format(-0.00001, decimalFormat)).toEqual("-0.00001"); - expect(numeralWrapper.format(-0.0001, decimalFormat)).toEqual("-0.0001"); - expect(numeralWrapper.format(-0.001, decimalFormat)).toEqual("-0.001"); - expect(numeralWrapper.format(-0.01, decimalFormat)).toEqual("-0.01"); - expect(numeralWrapper.format(-0.1, decimalFormat)).toEqual("-0.1"); - expect(numeralWrapper.format(-1, decimalFormat)).toEqual("-1"); - }); - test("should format big numbers in short format", () => { - expect(numeralWrapper.formatBigNumber(-987654000000000000)).toEqual("-987654.000t"); - expect(numeralWrapper.formatBigNumber(-987654300000000000)).toEqual("-987654.300t"); - expect(numeralWrapper.formatBigNumber(-987654320000000000)).toEqual("-987654.320t"); - expect(numeralWrapper.formatBigNumber(-987654321000000000)).toEqual("-987654.321t"); - expect(numeralWrapper.formatBigNumber(-987654321900000000)).toEqual("-987654.322t"); - }); - test("should format really big numbers in readable format", () => { - expect(numeralWrapper.formatReallyBigNumber(-987)).toEqual("-987.000"); - expect(numeralWrapper.formatReallyBigNumber(-987654)).toEqual("-987.654k"); - expect(numeralWrapper.formatReallyBigNumber(-987654321)).toEqual("-987.654m"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987)).toEqual("-987.654b"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654)).toEqual("-987.654t"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000)).toEqual("-987.654q"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000)).toEqual("-987.654Q"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000000)).toEqual("-987.654s"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000000000)).toEqual("-987.654S"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000000000000)).toEqual("-987.654o"); - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000000000000000)).toEqual("-987.654n"); - }); - test("should format even bigger really big numbers in scientific format", () => { - expect(numeralWrapper.formatReallyBigNumber(-987654321987654000000000000000000000)).toEqual("-9.877e+35"); - expect(numeralWrapper.formatReallyBigNumber(-9876543219876540000000000000000000000)).toEqual("-9.877e+36"); - expect(numeralWrapper.formatReallyBigNumber(-98765432198765400000000000000000000000)).toEqual("-9.877e+37"); - }); - test("should format percentage", () => { - expect(numeralWrapper.formatPercentage(-1234.56789)).toEqual("-123456.79%"); - }); -}); - -describe("Numeral formatting of text", () => { - test("should filter non-numeric text", () => { - expect(numeralWrapper.format("abc")).toEqual("0"); - expect(numeralWrapper.format("123abc")).toEqual("123"); - expect(numeralWrapper.format("!3")).toEqual("3"); - expect(numeralWrapper.format("3!")).toEqual("3"); - expect(numeralWrapper.format("0.001", decimalFormat)).toEqual("0.001"); - }); - test("should not format too small numbers", () => { - expect(numeralWrapper.format("0.00000001", decimalFormat)).toEqual("0"); - expect(numeralWrapper.format("0.0000001", decimalFormat)).toEqual("0"); - expect(numeralWrapper.format("0.000001", decimalFormat)).toEqual("0.000001"); - expect(numeralWrapper.format("0.00001", decimalFormat)).toEqual("0.00001"); - expect(numeralWrapper.format("1", decimalFormat)).toEqual("1"); - expect(numeralWrapper.format("-0.00000001", decimalFormat)).toEqual("0"); - expect(numeralWrapper.format("-0.0000001", decimalFormat)).toEqual("0"); - expect(numeralWrapper.format("-0.000001", decimalFormat)).toEqual("-0.000001"); - expect(numeralWrapper.format("-0.00001", decimalFormat)).toEqual("-0.00001"); - expect(numeralWrapper.format("-1", decimalFormat)).toEqual("-1"); - }); - test("should format big numbers in short format", () => { - expect(numeralWrapper.formatBigNumber("987654000000000000")).toEqual("987654.000t"); - expect(numeralWrapper.formatBigNumber("987654300000000000")).toEqual("987654.300t"); - expect(numeralWrapper.formatBigNumber("987654320000000000")).toEqual("987654.320t"); - expect(numeralWrapper.formatBigNumber("987654321000000000")).toEqual("987654.321t"); - expect(numeralWrapper.formatBigNumber("987654321900000000")).toEqual("987654.322t"); - expect(numeralWrapper.formatBigNumber("-987654000000000000")).toEqual("-987654.000t"); - expect(numeralWrapper.formatBigNumber("-987654300000000000")).toEqual("-987654.300t"); - expect(numeralWrapper.formatBigNumber("-987654320000000000")).toEqual("-987654.320t"); - expect(numeralWrapper.formatBigNumber("-987654321000000000")).toEqual("-987654.321t"); - expect(numeralWrapper.formatBigNumber("-987654321900000000")).toEqual("-987654.322t"); - }); - test("should format really big numbers in readable format", () => { - expect(numeralWrapper.formatReallyBigNumber("987")).toEqual("987.000"); - expect(numeralWrapper.formatReallyBigNumber("987654")).toEqual("987.654k"); - expect(numeralWrapper.formatReallyBigNumber("987654321")).toEqual("987.654m"); - expect(numeralWrapper.formatReallyBigNumber("987654321987")).toEqual("987.654b"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654")).toEqual("987.654t"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321")).toEqual("987.654q"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987")).toEqual("987.654Q"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987654")).toEqual("987.654s"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987654321")).toEqual("987.654S"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987654321987")).toEqual("987.654o"); - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987654321987654")).toEqual("987.654n"); - expect(numeralWrapper.formatReallyBigNumber("-987")).toEqual("-987.000"); - expect(numeralWrapper.formatReallyBigNumber("-987654")).toEqual("-987.654k"); - expect(numeralWrapper.formatReallyBigNumber("-987654321")).toEqual("-987.654m"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987")).toEqual("-987.654b"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654")).toEqual("-987.654t"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321")).toEqual("-987.654q"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987")).toEqual("-987.654Q"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987654")).toEqual("-987.654s"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987654321")).toEqual("-987.654S"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987654321987")).toEqual("-987.654o"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987654321987654")).toEqual("-987.654n"); - }); - test("should format even bigger really big numbers in scientific format", () => { - expect(numeralWrapper.formatReallyBigNumber("987654321987654321987654321987654321")).toEqual("9.877e+35"); - expect(numeralWrapper.formatReallyBigNumber("9876543219876543219876543219876543219")).toEqual("9.877e+36"); - expect(numeralWrapper.formatReallyBigNumber("98765432198765432198765432198765432198")).toEqual("9.877e+37"); - expect(numeralWrapper.formatReallyBigNumber("-987654321987654321987654321987654321")).toEqual("-9.877e+35"); - expect(numeralWrapper.formatReallyBigNumber("-9876543219876543219876543219876543219")).toEqual("-9.877e+36"); - expect(numeralWrapper.formatReallyBigNumber("-98765432198765432198765432198765432198")).toEqual("-9.877e+37"); - }); - test("should format percentage", () => { - expect(numeralWrapper.formatPercentage("1234.56789")).toEqual("123456.79%"); - expect(numeralWrapper.formatPercentage("-1234.56789")).toEqual("-123456.79%"); - }); -}); - -describe("Numeral formatting of scientific text", () => { - test("should format even bigger really big numbers in scientific format", () => { - // Accepted by numeral.js - expect(numeralWrapper.parseMoney("123")).toEqual(123); - expect(numeralWrapper.parseMoney("123.456")).toEqual(123.456); - expect(numeralWrapper.parseMoney("123k")).toEqual(123000); - expect(numeralWrapper.parseMoney("123.456k")).toEqual(123456); - expect(numeralWrapper.parseMoney("123m")).toEqual(123000000); - expect(numeralWrapper.parseMoney("123.456m")).toEqual(123456000); - expect(numeralWrapper.parseMoney("123b")).toEqual(123000000000); - expect(numeralWrapper.parseMoney("123.456b")).toEqual(123456000000); - expect(numeralWrapper.parseMoney("123t")).toEqual(123000000000000); - expect(numeralWrapper.parseMoney("123.456t")).toEqual(123456000000000); - // Custom formats, parseFloat has some rounding issues - expect(numeralWrapper.parseMoney("123q")).toBeCloseTo(123000000000000000); - expect(numeralWrapper.parseMoney("123.456q")).toBeCloseTo(123456000000000000); - expect(numeralWrapper.parseMoney("123Q")).toBeCloseTo(123000000000000000000); - expect(numeralWrapper.parseMoney("123.456Q")).toBeCloseTo(123456000000000000000); - expect(numeralWrapper.parseMoney("123s")).toBeCloseTo(123000000000000000000000); - expect(numeralWrapper.parseMoney("123.456s")).toBeCloseTo(123456000000000000000000); - expect(numeralWrapper.parseMoney("123S")).toBeCloseTo(123000000000000000000000000); - expect(numeralWrapper.parseMoney("123.456S")).toBeCloseTo(123456000000000000000000000); - // Larger numbers fail the test due to rounding issues - //expect(numeralWrapper.parseMoney('123o')).toBeCloseTo(123000000000000000000000000000); - //expect(numeralWrapper.parseMoney('123.456o')).toBeCloseTo(123456000000000000000000000000); - //expect(numeralWrapper.parseMoney('123n')).toBeCloseTo(123000000000000000000000000000000); - //expect(numeralWrapper.parseMoney('123.456n')).toBeCloseTo(123456000000000000000000000000000); - }); - test("should format even bigger really big negative numbers in scientific format", () => { - // Accepted by numeral.js - expect(numeralWrapper.parseMoney("-123")).toEqual(-123); - expect(numeralWrapper.parseMoney("-123.456")).toEqual(-123.456); - expect(numeralWrapper.parseMoney("-123k")).toEqual(-123000); - expect(numeralWrapper.parseMoney("-123.456k")).toEqual(-123456); - expect(numeralWrapper.parseMoney("-123m")).toEqual(-123000000); - expect(numeralWrapper.parseMoney("-123.456m")).toEqual(-123456000); - expect(numeralWrapper.parseMoney("-123b")).toEqual(-123000000000); - expect(numeralWrapper.parseMoney("-123.456b")).toEqual(-123456000000); - expect(numeralWrapper.parseMoney("-123t")).toEqual(-123000000000000); - expect(numeralWrapper.parseMoney("-123.456t")).toEqual(-123456000000000); - // Custom formats, parseFloat has some rounding issues - expect(numeralWrapper.parseMoney("-123q")).toBeCloseTo(-123000000000000000); - expect(numeralWrapper.parseMoney("-123.456q")).toBeCloseTo(-123456000000000000); - expect(numeralWrapper.parseMoney("-123Q")).toBeCloseTo(-123000000000000000000); - expect(numeralWrapper.parseMoney("-123.456Q")).toBeCloseTo(-123456000000000000000); - expect(numeralWrapper.parseMoney("-123s")).toBeCloseTo(-123000000000000000000000); - expect(numeralWrapper.parseMoney("-123.456s")).toBeCloseTo(-123456000000000000000000); - expect(numeralWrapper.parseMoney("-123S")).toBeCloseTo(-123000000000000000000000000); - expect(numeralWrapper.parseMoney("-123.456S")).toBeCloseTo(-123456000000000000000000000); - // Larger numbers fail the test due to rounding issues - //expect(numeralWrapper.parseMoney('-123o')).toBeCloseTo(-123000000000000000000000000000); - //expect(numeralWrapper.parseMoney('-123.456o')).toBeCloseTo(-123456000000000000000000000000); - //expect(numeralWrapper.parseMoney('-123n')).toBeCloseTo(-123000000000000000000000000000000); - //expect(numeralWrapper.parseMoney('-123.456n')).toBeCloseTo(-123456000000000000000000000000000); - }); -}); - -describe("Finding the number furthest away from 0", () => { - test("should work if all numbers are equal", () => { - expect(numeralWrapper.largestAbsoluteNumber(0, 0, 0)).toEqual(0); - expect(numeralWrapper.largestAbsoluteNumber(1, 1, 1)).toEqual(1); - expect(numeralWrapper.largestAbsoluteNumber(123, 123, 123)).toEqual(123); - expect(numeralWrapper.largestAbsoluteNumber(-1, -1, -1)).toEqual(-1); - expect(numeralWrapper.largestAbsoluteNumber(-123, -123, -123)).toEqual(-123); - }); - test("should work for different positive numbers, and for the largest number in each spot", () => { - expect(numeralWrapper.largestAbsoluteNumber(1, 2, 3)).toEqual(3); - expect(numeralWrapper.largestAbsoluteNumber(456, 789, 123)).toEqual(789); - expect(numeralWrapper.largestAbsoluteNumber(789123, 123456, 456789)).toEqual(789123); - }); - test("should work for different negative numbers, and for the smallest number in each spot", () => { - expect(numeralWrapper.largestAbsoluteNumber(-1, -2, -3)).toEqual(-3); - expect(numeralWrapper.largestAbsoluteNumber(-456, -789, -123)).toEqual(-789); - expect(numeralWrapper.largestAbsoluteNumber(-789123, -123456, -456789)).toEqual(-789123); - }); - test("should work for combined positive and negative numbers", () => { - expect(numeralWrapper.largestAbsoluteNumber(1, -2, 3)).toEqual(3); - expect(numeralWrapper.largestAbsoluteNumber(-456, 789, -123)).toEqual(789); - expect(numeralWrapper.largestAbsoluteNumber(789123, -123456, -456789)).toEqual(789123); - }); - test("Should return 0 for invalid input", () => { - expect( - numeralWrapper.largestAbsoluteNumber("abc" as unknown as number, undefined, null as unknown as number), - ).toEqual(0); - }); -}); diff --git a/tsdoc-metadata.json b/tsdoc-metadata.json index 11886848c..2546fe8a0 100644 --- a/tsdoc-metadata.json +++ b/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.19.4" + "packageVersion": "7.34.2" } ] }