diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index f8ced2dd8..ce537666b 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -65,124 +65,13 @@ export declare interface AugmentationStats { bladeburner_success_chance_mult?: number; } -/** - * All augmentation names. - * @public - */ -export declare type AugmentName = -| "Augmented Targeting I" -| "Augmented Targeting II" -| "Augmented Targeting III" -| "Synthetic Heart" -| "Synfibril Muscle" -| "Combat Rib I" -| "Combat Rib II" -| "Combat Rib III" -| "Nanofiber Weave" -| "NEMEAN Subdermal Weave" -| "Wired Reflexes" -| "Graphene Bone Lacings" -| "Bionic Spine" -| "Graphene Bionic Spine Upgrade" -| "Bionic Legs" -| "Graphene Bionic Legs Upgrade" -| "Speech Processor Implant" -| "TITN-41 Gene-Modification Injection" -| "Enhanced Social Interaction Implant" -| "BitWire" -| "Artificial Bio-neural Network Implant" -| "Artificial Synaptic Potentiation" -| "Enhanced Myelin Sheathing" -| "Synaptic Enhancement Implant" -| "Neural-Retention Enhancement" -| "DataJack" -| "Embedded Netburner Module" -| "Embedded Netburner Module Core Implant" -| "Embedded Netburner Module Core V2 Upgrade" -| "Embedded Netburner Module Core V3 Upgrade" -| "Embedded Netburner Module Analyze Engine" -| "Embedded Netburner Module Direct Memory Access Upgrade" -| "Neuralstimulator" -| "Neural Accelerator" -| "Cranial Signal Processors - Gen I" -| "Cranial Signal Processors - Gen II" -| "Cranial Signal Processors - Gen III" -| "Cranial Signal Processors - Gen IV" -| "Cranial Signal Processors - Gen V" -| "Neuronal Densification" -| "Nuoptimal Nootropic Injector Implant" -| "Speech Enhancement" -| "FocusWire" -| "PC Direct-Neural Interface" -| "PC Direct-Neural Interface Optimization Submodule" -| "PC Direct-Neural Interface NeuroNet Injector" -| "ADR-V1 Pheromone Gene" -| "ADR-V2 Pheromone Gene" -| "The Shadow's Simulacrum" -| "Hacknet Node CPU Architecture Neural-Upload" -| "Hacknet Node Cache Architecture Neural-Upload" -| "Hacknet Node NIC Architecture Neural-Upload" -| "Hacknet Node Kernel Direct-Neural Interface" -| "Hacknet Node Core Direct-Neural Interface" -| "NeuroFlux Governor" -| "Neurotrainer I" -| "Neurotrainer II" -| "Neurotrainer III" -| "HyperSight Corneal Implant" -| "LuminCloaking-V1 Skin Implant" -| "LuminCloaking-V2 Skin Implant" -| "HemoRecirculator" -| "SmartSonar Implant" -| "Power Recirculation Core" -| "QLink" -| "The Red Pill" -| "SPTN-97 Gene Modification" -| "ECorp HVMind Implant" -| "CordiARC Fusion Reactor" -| "SmartJaw" -| "Neotra" -| "Xanipher" -| "nextSENS Gene Modification" -| "OmniTek InfoLoad" -| "Photosynthetic Cells" -| "BitRunners Neurolink" -| "The Black Hand" -| "CRTX42-AA Gene Modification" -| "Neuregen Gene Modification" -| "CashRoot Starter Kit" -| "NutriGen Implant" -| "INFRARET Enhancement" -| "DermaForce Particle Barrier" -| "Graphene BranchiBlades Upgrade" -| "Graphene Bionic Arms Upgrade" -| "BrachiBlades" -| "Bionic Arms" -| "Social Negotiation Assistant (S.N.A)" -| "EsperTech Bladeburner Eyewear" -| "EMS-4 Recombination" -| "ORION-MKIV Shoulder" -| "Hyperion Plasma Cannon V1" -| "Hyperion Plasma Cannon V2" -| "GOLEM Serum" -| "Vangelis Virus" -| "Vangelis Virus 3.0" -| "I.N.T.E.R.L.I.N.K.E.D" -| "Blade's Runners" -| "BLADE-51b Tesla Armor" -| "BLADE-51b Tesla Armor: Power Cells Upgrade" -| "BLADE-51b Tesla Armor: Energy Shielding Upgrade" -| "BLADE-51b Tesla Armor: Unibeam Upgrade" -| "BLADE-51b Tesla Armor: Omnibeam Upgrade" -| "BLADE-51b Tesla Armor: IPU Upgrade" -| "The Blade's Simulacrum"; - /** * Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} * @public */ export declare interface AugmentPair { /** augmentation name */ - name: AugmentName; + name: string; /** augmentation cost */ cost: number; } @@ -284,160 +173,152 @@ export declare interface BitNodeMultipliers { } /** + * 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 { /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all contracts. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner contracts. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner contracts. */ - getContractNames(): BladeburnerContracts[]; + getContractNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all operations. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner operations. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner operations. */ - getOperationNames(): BladeburnerOperations[]; + getOperationNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all black ops. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner Black Ops. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner Black Ops. */ - getBlackOpNames(): BladeburnerBlackOps[]; + getBlackOpNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all general actions. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all general Bladeburner actions. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all general Bladeburner actions. */ - getGeneralActionNames(): BladeburnerGenActions[]; + getGeneralActionNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all skills. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all general Bladeburner skills. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all general Bladeburner skills. */ - getSkillNames(): BladeburnerSkills[]; + getSkillNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match * @returns True if the action was started successfully, and false otherwise. */ - startAction( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; + startAction(type: string, name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Stop current action. + * @remarks + * RAM cost: 2 GB * * Stops the current Bladeburner action. * - * @remarks RAM cost: 2 GB */ stopBladeburnerAction(): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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”. * - * @remarks RAM cost: 1 GB * @returns Object that represents the player’s current Bladeburner action. */ getCurrentAction(): BladeburnerCurAction; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get the time to complete an action. + * @remarks + * RAM cost: 4 GB * * Returns the number of seconds it takes to complete the specified action * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. - * @returns Number of seconds it takes to complete the specified action. + * @returns Number of milliseconds it takes to complete the specified action. */ - getActionTime( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionTime(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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). * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Estimated success chance for the specified action. */ - getActionEstimatedSuccessChance( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionEstimatedSuccessChance(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param level - Optional action level at which to calculate the gain * @returns Average Bladeburner reputation gain for successfully completing the specified action. */ - getActionRepGain( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): number; + getActionRepGain(type: string, name: string, level: number): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get action count remaining. + * @remarks + * RAM cost: 4 GB * * Returns the remaining count of the specified action. * @@ -446,288 +327,259 @@ export declare interface Bladeburner { * This function will return 1 for BlackOps not yet completed regardless of wether * the player has the required rank to attempt the mission or not. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Remaining count of the specified action. */ - getActionCountRemaining( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionCountRemaining(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Maximum level of the specified action. */ - getActionMaxLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionMaxLevel(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Current level of the specified action. */ - getActionCurrentLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionCurrentLevel(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get wether 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns True if the action is set to autolevel, and false otherwise. */ - getActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; + getActionAutolevel(type: string, name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set an action autolevel. + * @remarks + * RAM cost: 4 GB * * Enable/disable autoleveling for the specified action. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param autoLevel - Whether or not to autolevel this action */ - setActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - autoLevel: boolean, - ): void; + setActionAutolevel(type: string, name: string, autoLevel: boolean): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set the level of an action. + * @remarks + * RAM cost: 4 GB * * Set the level for the specified action. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param level - Level to set this action to. */ - setActionLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): void; + setActionLevel(type: string, name: string, level: number): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get player bladeburner rank. + * @remarks + * RAM cost: 4 GB * * Returns the player’s Bladeburner Rank. * - * @remarks RAM cost: 4 GB * @returns Player’s Bladeburner Rank. */ getRank(): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 2 GB * @param name - Name of BlackOp. Must be an exact match. * @returns Rank required to complete this BlackOp. */ - getBlackOpRank(name: BladeburnerBlackOps): number; + getBlackOpRank(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get bladeburner skill points. + * @remarks + * RAM cost: 4 GB * * Returns the number of Bladeburner skill points you have. * - * @remarks RAM cost: 4 GB * @returns Number of Bladeburner skill points you have. */ getSkillPoints(): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill. Case-sensitive and must be an exact match * @returns Level in the specified skill. */ - getSkillLevel(name: BladeburnerSkills): number; + getSkillLevel(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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 function returns -1 if an invalid skill name is passed in. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill. Case-sensitive and must be an exact match * @returns Number of skill points needed to upgrade the specified skill. */ - getSkillUpgradeCost(name: BladeburnerSkills): number; + getSkillUpgradeCost(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Upgrade skill. + * @remarks + * RAM cost: 4 GB * * Attempts to upgrade the specified Bladeburner skill. * * Returns true if the skill is successfully upgraded, and false otherwise. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match * @returns true if the skill is successfully upgraded, and false otherwise. */ - upgradeSkill(name: BladeburnerSkills): boolean; + upgradeSkill(name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Number of Bladeburner team members that were assigned to the specified action. */ - getTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getTeamSize(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param size - Number of team members to set. Will be converted using Math.round(). * @returns Number of Bladeburner team members you assigned to the specified action. */ - setTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - size: number, - ): number; + setTeamSize(type: string, name: string, size: number): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Estimated number of Synthoids in the specified city. */ - getCityEstimatedPopulation(name: City): number; + getCityEstimatedPopulation(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Number of Synthoids communities in the specified city. */ - getCityCommunities(name: City): number; + getCityCommunities(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Chaos in the specified city. */ - getCityChaos(name: City): number; + getCityChaos(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get current city. + * @remarks + * RAM cost: 4 GB * * Returns the city that the player is currently in (for Bladeburner). * - * @remarks RAM cost: 4 GB * @returns City that the player is currently in (for Bladeburner). */ - getCity(): City; + getCity(): string; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * 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 * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns true if successful, and false otherwise */ - switchCity(name: City): boolean; + switchCity(name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * Get bladeburner stamina. + * @remarks + * RAM cost: 4 GB * Returns an array with two elements: * * [Current stamina, Max stamina] * @example @@ -737,29 +589,28 @@ export declare interface Bladeburner { * return res[0] / res[1]; * } * ``` - * @remarks RAM cost: 4 GB * @returns Array containing current stamina and max stamina. */ getStamina(): [number, number]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * 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. * - * @remarks RAM cost: 4 GB * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. */ joinBladeburnerFaction(): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Join the bladeburner division. + * @remarks + * RAM cost: 4 GB * * Attempts to join the Bladeburner division. * @@ -767,14 +618,14 @@ export declare interface Bladeburner { * * Returns false otherwise. * - * @remarks RAM cost: 4 GB * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. */ joinBladeburnerDivision(): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get bladeburner bonus time. + * @remarks + * RAM cost: 0 GB * * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. * @@ -784,104 +635,22 @@ export declare interface Bladeburner { * For example, if an action takes 30 seconds to complete but you’ve accumulated over * 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. * - * @remarks RAM cost: 0 GB - * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + * @returns Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. */ getBonusTime(): number; } -/** - * All Bladeburner action types. - * @public - */ -export declare type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; - -/** - * All Bladeburner black ops. - * @public - */ -export declare type BladeburnerBlackOps = -| "Operation Typhoon" -| "Operation Zero" -| "Operation X" -| "Operation Titan" -| "Operation Ares" -| "Operation Archangel" -| "Operation Juggernaut" -| "Operation Red Dragon" -| "Operation K" -| "Operation Deckard" -| "Operation Tyrell" -| "Operation Wallace" -| "Operation Shoulder of Orion" -| "Operation Hyron" -| "Operation Morpheus" -| "Operation Ion Storm" -| "Operation Annihilus" -| "Operation Ultron" -| "Operation Centurion" -| "Operation Vindictus" -| "Operation Daedalus"; - -/** - * @public - */ -export declare type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; - /** * Bladeburner current action. * @public */ export declare interface BladeburnerCurAction { /** Type of Action */ - type: BladeburnerActTypes | "Idle"; + type: string; /** Name of Action */ - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; + name: string; } -/** - * All Bladeburner General Actions. - * @public - */ -export declare type BladeburnerGenActions = -| "Training" -| "Field Analysis" -| "Recruitment" -| "Diplomacy" -| "Hyperbolic Regeneration Chamber"; - -/** - * All Bladeburner Ops. - * @public - */ -export declare type BladeburnerOperations = -| "Investigation" -| "Undercover Operation" -| "Sting Operation" -| "Raid" -| "Stealth Retirement Operation" -| "Assassination"; - -/** - * All Bladeburner Skills. - * @public - */ -export declare type BladeburnerSkills = -| "Blade's Intuition" -| "Cloak" -| "Marksman" -| "Weapon Proficiency" -| "Short-Circuit" -| "Digital Observer" -| "Tracer" -| "Overclock" -| "Reaper" -| "Evasive System" -| "Datamancer" -| "Cyber's Edge" -| "Hands of Midas" -| "Hyperdrive"; - /** * @public */ @@ -889,15 +658,15 @@ export declare interface CharacterInfo { /** Current BitNode number */ bitnode: number; /** Name of city you are currently in */ - city: City; + city: string; /** Array of factions you are currently a member of */ - factions: FactionName[]; + factions: string[]; /** Current health points */ hp: number; /** Array of all companies at which you have jobs */ - company: CompanyName[]; + company: string[]; /** Array of job positions for all companies you are employed at. Same order as 'jobs' */ - jobTitle: CompanyField[]; + jobTitle: string[]; /** Maximum health points */ maxHp: number; /** Boolean indicating whether or not you have a tor router */ @@ -960,12 +729,6 @@ export declare interface CharacterMult { workMoney: number; } -/** - * All cities. - * @public - */ -export declare type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; - /** * Options to affect the behavior of {@link CodingContract} attempt. * @public @@ -981,186 +744,90 @@ export declare interface CodingAttemptOptions { */ export declare interface CodingContract { /** + * Attemps a coding contract. + * @remarks + * RAM cost: 10 GB + * * Attempts to solve the Coding Contract with the provided solution. * - * @remarks 10 GB * @param answer - Solution for the contract. * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns True if the solution was correct, false otherwise. */ - attempt(answer: string | string[] | number, fn: string, host?: string): boolean; + attempt(answer: string[] | number, fn: string, host?: string): boolean; /** + * Attemps a coding contract. + * @remarks + * RAM cost: 10 GB + * * Attempts to solve the Coding Contract with the provided solution. * - * @remarks 10 GB * @param answer - Solution for the contract. * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @param opts - Optional parameters for configuring function behavior. * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. */ - attempt(answer: string | string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string; + attempt(answer: string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | 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.) * - * @remarks RAM cost: 5 GB * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns Name describing the type of problem posed by the Coding Contract. */ - getContractType(fn: string, host?: string): CodingContractTypes; + getContractType(fn: 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. * - * @remarks RAM cost: 5 GB * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns Contract’s text description. */ getDescription(fn: 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 * - * @remarks RAM cost: 5 GB * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns The specified contract’s data; */ getData(fn: string, host?: string): string; /** + * Get the number of attempt remaining. + * @remarks + * RAM cost: 2 GB + * * Get the number of tries remaining on the contract before it self-destructs. * - * @remarks RAM cost: 2 GB * @param fn - Filename of the contract. - * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns How many attempts are remaining for the contract; */ getNumTriesRemaining(fn: string, host?: string): number; } -/** - * All Coding contract types. - * @public - */ -export declare type CodingContractTypes = -| "Find Largest Prime Factor" -| "Subarray with Maximum Sum" -| "Total Ways to Sum" -| "Spiralize Matrix" -| "Array Jumping Game" -| "Merge Overlapping Intervals" -| "Generate IP Addresses" -| "Algorithmic Stock Trader I" -| "Algorithmic Stock Trader II" -| "Algorithmic Stock Trader III" -| "Algorithmic Stock Trader IV" -| "Minimum Path Sum in a Triangle" -| "Unique Paths in a Grid I" -| "Unique Paths in a Grid II" -| "Sanitize Parentheses in Expression" -| "Find All Valid Math Expressions"; - -/** - * All company work fields. - * @public - */ -export declare type CompanyField = -| "software" -| "software consultant" -| "it" -| "security engineer" -| "network engineer" -| "business" -| "business consultant" -| "security" -| "agent" -| "employee" -| "part-time employee" -| "waiter" -| "part-time waiter"; - -/** - * All companies. - * @public - */ -export declare type CompanyName = -// Sector-12 -| "MegaCorp" -| "BladeIndustries" -| "FourSigma" -| "IcarusMicrosystems" -| "UniversalEnergy" -| "DeltaOne" -| "CIA" -| "NSA" -| "AlphaEnterprises" -| "CarmichaelSecurity" -| "FoodNStuff" -| "JoesGuns" - -// Aevum -| "ECorp" -| "BachmanAndAssociates" -| "ClarkeIncorporated" -| "OmniTekIncorporated" -| "FulcrumTechnologies" -| "GalacticCybersystems" -| "AeroCorp" -| "WatchdogSecurity" -| "RhoConstruction" -| "AevumPolice" -| "NetLinkTechnologies" - -// Volhaven -| "NWO" -| "HeliosLabs" -| "OmniaCybersystems" -| "LexoCorp" -| "SysCoreSecurities" -| "CompuTek" - -// Chongqing -| "KuaiGongInternational" -| "SolarisSpaceSystems" - -// Ishima -| "StormTechnologies" -| "NovaMedical" -| "OmegaSoftware" - -// New Tokyo -| "DefComm" -| "VitaLife" -| "GlobalPharmaceuticals" -| "NoodleBar"; - -/** - * All crimes. - * @public - */ -export declare type Crime = -| "shoplift" -| "rob store" -| "mug" -| "larceny" -| "deal drugs" -| "bond forgery" -| "traffick arms" -| "homicide" -| "grand theft auto" -| "kidnap" -| "assassinate" -| "heist"; - /** * Data representing the internal values of a crime. * @public @@ -1208,108 +875,73 @@ export declare interface CrimeStats { intelligence_exp: number; } -/** - * All factions. - * @public - */ -export declare type FactionName = -| "Illuminati" -| "Daedalus" -| "The Covenant" -| "ECorp" -| "MegaCorp" -| "Bachman & Associates" -| "Blade Industries" -| "NWO" -| "Clarke Incorporated" -| "OmniTek Incorporated" -| "Four Sigma" -| "KuaiGong International" -| "Fulcrum Secret Technologies" -| "BitRunners" -| "The Black Hand" -| "NiteSec" -| "Aevum" -| "Chongqing" -| "Ishima" -| "New Tokyo" -| "Sector-12" -| "Volhaven" -| "Speakers for the Dead" -| "The Dark Army" -| "The Syndicate" -| "Silhouette" -| "Tetrads" -| "Slum Snakes" -| "Netburners" -| "Tian Di Hui" -| "CyberSec" -| "Bladeburners"; - -/** - * All faction work types. - * @public - */ -export declare type FactionWork = "hacking" | "field" | "security"; - /** * 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 { /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * List all gang members. + * @remarks + * RAM cost: 1 GB * * Get the names of all Gang members * - * @remarks RAM cost: 1 GB * @returns Names of all Gang members. */ getMemberNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about your gang. + * @remarks + * RAM cost: 2 GB * * Get general information about the gang. * - * @remarks RAM cost: 2 GB * @returns Object containing general information about the gang. */ getGangInformation(): GangGenInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about the other gangs. + * @remarks + * RAM cost: 2 GB * * Get territory and power information about all gangs. * - * @remarks RAM cost: 2 GB * @returns Object containing territory and power information about all gangs. */ getOtherGangInformation(): GangOtherInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about a specific gang member. + * @remarks + * RAM cost: 2 GB * * Get stat and equipment-related information about a Gang Member * - * @remarks RAM cost: 2 GB * @param name - Name of member. * @returns Object containing stat and equipment-related information about a Gang Member. */ getMemberInformation(name: string): GangMemberInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Check if you can recruit a new gang member. + * @remarks + * RAM cost: 1 GB * * Returns boolean indicating whether a member can currently be recruited * - * @remarks RAM cost: 1 GB * @returns True if a member can currently be recruited, false otherwise. */ canRecruitMember(): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Recruit a new gang member. + * @remarks + * RAM cost: 2 GB * * Attempt to recruit a new gang member. * @@ -1317,137 +949,149 @@ export declare interface Gang { * * Cannot currently recruit a new member * * There already exists a member with the specified name * - * @remarks RAM cost: 2 GB * @param name - Name of member to recruit. * @returns True if the member was successfully recruited, false otherwise. */ recruitMember(name: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * List member task names. + * @remarks + * RAM cost: 1 GB * * Get the name of all valid tasks that Gang members can be assigned to. * - * @remarks RAM cost: 1 GB * @returns All valid tasks that Gang members can be assigned to. */ - getTaskNames(): GangTasks[]; + getTaskNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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”). * - * @remarks RAM cost: 2 GB * @param memberName - Name of Gang member to assign. * @param taskName - Task to assign. * @returns True if the Gang Member was successfully assigned to the task, false otherwise. */ - setMemberTask(memberName: string, taskName: GangTasks): boolean; + setMemberTask(memberName: string, taskName: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 1 GB * @param name - Name of the task. * @returns Detailed stats of a task. */ - getTaskStats(name: GangTasks): GangTasksStats; + getTaskStats(name: string): stringStats; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 1 GB * @returns Names of all Equpiment/Augmentations. */ - getEquipmentNames(): (GangEquipment | GangAugmentations)[]; + getEquipmentNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments */ - getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; + getEquipmentCost(equipName: string): number; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get type of an equipment. + * @remarks + * RAM cost: 2 GB * * Get the specified equipment type. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns Type of the equipment. */ - getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; + getEquipmentType(equipName: string): string; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get stats of an equipment. + * @remarks + * RAM cost: 2 GB * * Get the specified equipment stats. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns A dictionary containing the stats of the equipment. */ - getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; + getEquipmentStats(equipName: string): stringStats; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Purchase an equipment for a gang member. + * @remarks + * RAM cost: 4 GB * * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. * - * @remarks RAM cost: 4 GB * @param memberName - Name of Gang member to purchase the equipment for. * @param equipName - Name of Equipment/Augmentation to purchase. * @returns True if the equipment was successfully purchased. False otherwise */ - purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; + purchaseEquipment(memberName: string, equipName: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Ascend a gang member. + * @remarks + * RAM cost: 4 GB * * Ascend the specified Gang Member. * - * @remarks RAM cost: 4 GB * @param memberName - Name of member to ascend. * @returns Object with info about the ascension results. */ ascendMember(memberName: string): GangMemberAscension; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Enable/Disable territory warfare. + * @remarks + * RAM cost: 2 GB * * Set whether or not the gang should engage in territory warfare * - * @remarks RAM cost: 2 GB * @param engage - Whether or not to engage in territory warfare. */ setTerritoryWarfare(engage: boolean): void; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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 * - * @remarks RAM cost: 4 GB * @param gangName - Target gang * @returns Chance you have to win a clash with the specified gang. */ - getChanceToWinClash(gangName: GangName): number; + getChanceToWinClash(gangName: string): number; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get bonus time. + * @remarks + * RAM cost: 0 GB * * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. * @@ -1455,88 +1099,18 @@ export declare interface Gang { * * “Bonus time” makes the game progress faster, up to 10x the normal speed. * - * @remarks RAM cost: 0 GB - * @returns Bonus time for the Gang mechanic in seconds. + * @returns Bonus time for the Gang mechanic in milliseconds. */ getBonusTime(): number; } -/** - * All Gang augmentations. - * @public - */ -export declare type GangAugmentations = -| "Bionic Arms" -| "Bionic Legs" -| "Bionic Spine" -| "BrachiBlades" -| "Nanofiber Weave" -| "Synthetic Heart" -| "Synfibril Muscle" -| "BitWire" -| "Neuralstimulator" -| "DataJack" -| "Graphene Bone Lacings"; - -/** - * All Gang equipment. - * @public - */ -export declare type GangEquipment = -| "Baseball Bat" -| "Katana" -| "Glock 18C" -| "P90C" -| "Steyr AUG" -| "AK-47" -| "M15A10 Assault Rifle" -| "AWM Sniper Rifle" -| "Bulletproof Vest" -| "Full Body Armor" -| "Liquid Body Armor" -| "Graphene Plating Armor" -| "Ford Flex V20" -| "ATX1070 Superbike" -| "Mercedes-Benz S9001" -| "White Ferrari" -| "NUKE Rootkit" -| "Soulstealer Rootkit" -| "Demon Rootkit" -| "Hmap Node" -| "Jack the Ripper"; - -/** - * Object representing data representing a gang member equipment. - * @public - */ -export declare interface GangEquipmentStats { - /** Strength multiplier */ - str: number; - /** Defense multiplier */ - def: number; - /** Dexterity multiplier */ - dex: number; - /** Agility multiplier */ - agi: number; - /** Charisma multiplier */ - cha: number; - /** Hacking multiplier */ - hack: number; -} - -/** - * All Gang equipment type. - * @public - */ -export declare type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; - /** * Gang general info. * @public */ export declare interface GangGenInfo { /** Name of faction that the gang belongs to ("Slum Snakes", etc.) */ - faction: GangName; + faction: string; /** Boolean indicating whether or not its a hacking gang */ isHacking: boolean; /** Money earned per second */ @@ -1588,7 +1162,7 @@ export declare interface GangMemberInfo { /** Agility multiplier from ascension.*/ agilityAscensionMult: number; /** Array of names of all owned Augmentations */ - augmentations: GangAugmentations[]; + augmentations: string[]; /** Charisma stat */ charisma: number; /** Charisma multiplier from equipment.*/ @@ -1608,7 +1182,7 @@ export declare interface GangMemberInfo { /** Dexterity multiplier from ascension.*/ dexterityAscensionMult: number; /** Array of names of all owned Non-Augmentation Equipment */ - equipment: GangEquipment[]; + equipment: string[]; /** Hacking stat */ hacking: number; /** Hacking multiplier from equipment.*/ @@ -1622,28 +1196,15 @@ export declare interface GangMemberInfo { /** Strength multiplier from ascension.*/ strengthAscensionMult: number; /** Name of currently assigned task */ - task: GangTasks; + task: string; } -/** - * All factions that can have a gang. - * @public - */ -export declare type GangName = -| "Slum Snakes" -| "Tetrads" -| "The Syndicate" -| "The Dark Army" -| "Speakers for the Dead" -| "NiteSec" -| "The Black Hand"; - /** * @public */ export declare type GangOtherInfo = { /** Stock Symbol */ - [key in GangName]: GangOtherInfoObject[]; + [key: string]: GangOtherInfoObject[]; }; /** @@ -1656,97 +1217,6 @@ export declare interface GangOtherInfoObject { territory: number; } -/** - * All Gang tasks. - * @public - */ -export declare type GangTasks = -| "Unassigned" -| "Ransomware" -| "Phishing" -| "Identity Theft" -| "DDoS Attacks" -| "Plant Virus" -| "Fraud & Counterfeiting" -| "Money Laundering" -| "Cyberterrorism" -| "Ethical Hacking" -| "Mug People" -| "Deal Drugs" -| "Strongarm Civilians" -| "Run a Con" -| "Armed Robbery" -| "Traffick Illegal Arms" -| "Threaten & Blackmail" -| "Human Trafficking" -| "Terrorism" -| "Vigilante Justice" -| "Train Combat" -| "Train Hacking" -| "Train Charisma" -| "Territory Warfare"; - -/** - * Object representing data representing a gang member task. - * @public - */ -export declare interface GangTasksStats { - /** Task name */ - name: GangTasks; - /** Task Description */ - desc: string; - /** Is a task of a hacking gang */ - isHacking: boolean; - /** Is a task of a combat gang */ - isCombat: boolean; - /** Base respect earned */ - baseRespect: number; - /** Base wanted earned */ - baseWanted: number; - /** Base money earned */ - baseMoney: number; - /** Hacking skill impact on task scaling */ - hackWeight: number; - /** Stength skill impact on task scaling */ - strWeight: number; - /** Defense skill impact on task scaling */ - defWeight: number; - /** Dexterity skill impact on task scaling */ - dexWeight: number; - /** Agility skill impact on task scaling */ - agiWeight: number; - /** Charisma skill impact on task scaling */ - chaWeight: number; - /** Number representing the difficulty of the task */ - difficulty: number; - /** Territory impact on task scaling */ - territory: GangTasksTerritory; -} - -/** - * @public - */ -export declare interface GangTasksTerritory { - /** Money gain impact on task scaling */ - money: number; - /** Respect gain impact on task scaling */ - respect: number; - /** Wanted gain impact on task scaling */ - wanted: number; -} - -/** - * All gyms. - * @public - */ -export declare type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; - -/** - * All stats that can be trained at gyms. - * @public - */ -export declare type GymStat = "str" | "def" | "dex" | "agi"; - /** * Hack related multipliers. * @public @@ -1764,18 +1234,27 @@ export declare interface HackingMultipliers { /** * 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. * - * @remarks RAM cost: 0 GB * @returns number of hacknet nodes. */ numNodes(): 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` @@ -1783,33 +1262,42 @@ export declare interface Hacknet { * * If the player cannot afford to purchase a new Hacknet Node then the function will return -1. * - * @remarks RAM cost: 0 GB * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. */ purchaseNode(): number; /** + * Get the price of the next hacknet node. + * @remarks + * RAM cost: 0 GB + * * Returns the cost of purchasing a new Hacknet Node. * - * @remarks RAM cost: 0 GB * @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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node * @returns Object containing a variety of stats about the specified Hacknet Node. */ getNodeStats(index: number): NodeStats; /** + * 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 @@ -1817,7 +1305,6 @@ export declare interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise. @@ -1825,6 +1312,10 @@ export declare interface Hacknet { 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. @@ -1834,7 +1325,6 @@ export declare interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise. @@ -1842,6 +1332,10 @@ export declare interface Hacknet { 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 @@ -1849,7 +1343,6 @@ export declare interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. @@ -1857,6 +1350,10 @@ export declare interface Hacknet { 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. @@ -1866,7 +1363,6 @@ export declare interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. @@ -1874,12 +1370,15 @@ export declare interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node. @@ -1887,12 +1386,15 @@ export declare interface Hacknet { 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 is already at max level, then Infinity is returned. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's ram. @@ -1900,12 +1402,15 @@ export declare interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's number of cores. @@ -1913,6 +1418,10 @@ export declare interface Hacknet { 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. @@ -1920,7 +1429,6 @@ export declare interface Hacknet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's cache. @@ -1928,16 +1436,23 @@ export declare interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @returns Number of hashes you have. */ numHashes(): 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. @@ -1949,13 +1464,16 @@ export declare interface Hacknet { * hacknet.spendHashes(upgName); * } * ``` - * @remarks RAM cost: 0 GB * @param upgName - Name of the upgrade of Hacknet Node. * @returns Number of hashes required for the specified upgrade. */ - hashCost(upgName: HashUpgrades): number; + hashCost(upgName: string): 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. @@ -1970,12 +1488,11 @@ export declare interface Hacknet { * hacknet.spendHashes("Sell for Corporation Funds"); * hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); * ``` - * @remarks RAM cost: 0 GB * @param upgName - Name of the upgrade of Hacknet Node. * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. * @returns True if the upgrade is successfully purchased, and false otherwise.. */ - spendHashes(upgName: HashUpgrades, upgTarget?: string): boolean; + spendHashes(upgName: string, upgTarget?: string): boolean; } /** @@ -2000,22 +1517,6 @@ export declare interface HacknetMultipliers { */ export declare type Handle = string | Port; -/** - * All Hash upgrade names. - * @public - */ -export declare type HashUpgrades = -| "Sell for Money" -| "Sell for Corporation Funds" -| "Reduce Minimum Security" -| "Increase Maximum Money" -| "Improve Studying" -| "Improve Gym Training" -| "Exchange for Corporation Research" -| "Exchange for Bladeburner Rank" -| "Exchange for Bladeburner SP" -| "Generate Coding Contract"; - /** * Object representing all the values related to a hacknet node. * @public @@ -2048,14 +1549,7 @@ export declare interface NodeStats { export declare interface NS extends Singularity { /** * Namespace for hacknet related functions. - * @remarks - * Not all functions in the Hacknet Node API are immediately available. - * - * Note that none of these functions will write to the script’s logs. - * - * If you want to see what your script is doing you will have to print to the logs yourself. - * - * 4 GB + * @remarks RAM cost: 4 GB */ readonly hacknet: Hacknet; /** @@ -2102,6 +1596,9 @@ export declare interface NS extends Singularity { readonly args: (string | number)[]; /** + * Steal a servers 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. In order to hack a server you must first gain root access to that server @@ -2116,10 +1613,8 @@ export declare interface NS extends Singularity { * @example * ```ts * hack("foodnstuff"); - * hack("10.1.2.3"); * hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack * ``` - * @remarks RAM cost: 0.1 GB * @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. @@ -2127,6 +1622,9 @@ export declare interface NS extends Singularity { hack(host: string, opts?: BasicHGWOptions): Promise; /** + * Spoof money in a servers 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 @@ -2144,7 +1642,6 @@ export declare interface NS extends Singularity { * grow("foodnstuff"); * grow("foodnstuff", { threads: 5 }); // Only use 5 threads to grow * ``` - * @remarks RAM cost: 0.15 GB * @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. @@ -2152,6 +1649,9 @@ export declare interface NS extends Singularity { grow(host: string, opts?: BasicHGWOptions): Promise; /** + * Reduce a server 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 command depends on your hacking level and the target server’s security * level. This function lowers the security level of the target server by 0.05. @@ -2165,7 +1665,6 @@ export declare interface NS extends Singularity { * weaken("foodnstuff"); * weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken * ``` - * @remarks RAM cost: 0.15 GB * @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. @@ -2173,9 +1672,11 @@ export declare interface NS extends Singularity { 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. * - * @remarks RAM cost: 1 GB * @param threads - Amount of threads that will be used. * @param cores - Optional. The number of cores of the server that would run weaken. * @returns The security decrease. @@ -2183,6 +1684,9 @@ export declare interface NS extends Singularity { 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, @@ -2196,7 +1700,6 @@ export declare interface NS extends Singularity { * hackAnalyzeThreads("foodnstuff", 1e6); * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. * ``` - * @remarks RAM cost: 1 GB * @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. @@ -2653,10 +2156,10 @@ export declare interface NS extends Singularity { * ``` * @remarks RAM cost: 0.6 GB * @param files - Filename or an array of filenames of script/literature files to copy. - * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @param destination - Host of the destination server, which is the server to which the file will be copied. * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ - scp(files: string | ReadonlyArray, destination: string): boolean; + scp(files: string[], destination: string): boolean; /** * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string @@ -2675,12 +2178,12 @@ export declare interface NS extends Singularity { * ``` * @remarks RAM cost: 0.6 GB * @param files - Filename or an array of filenames of script/literature files to copy. - * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. - * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. + * @param destination - Host of the destination server, which is the server to which the file will be copied. * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ scp( - files: string | ReadonlyArray, + files: string[], source: string, // tslint:disable-next-line:unified-signatures destination: string, @@ -2691,7 +2194,7 @@ export declare interface NS extends Singularity { * (as strings). The returned array is sorted in alphabetic order. * * @remarks RAM cost: 0.2 GB - * @param host - Host or IP of the target server. + * @param host - Host 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. */ @@ -2712,7 +2215,7 @@ export declare interface NS extends Singularity { * } * ``` * @remarks RAM cost: 0.2 GB - * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default. + * @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[]; @@ -2727,7 +2230,7 @@ export declare interface NS extends Singularity { * } * ``` * @remarks RAM cost: 0.05 GB - * @param host - Host or IP of the target server + * @param host - Host of the target server * @returns True if player has root access to the specified target server, and false otherwise. */ hasRootAccess(host: string): boolean; @@ -2801,7 +2304,7 @@ export declare interface NS extends Singularity { * getServerMoneyAvailable("home"); //Returns player's money * ``` * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server + * @param host - Host of target server * @returns Amount of money available on the server. */ getServerMoneyAvailable(host: string): number; @@ -2810,7 +2313,7 @@ export declare interface NS extends Singularity { * Returns the maximum amount of money that can be available on a server. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns Maximum amount of money available on the server. */ getServerMaxMoney(host: string): number; @@ -2824,7 +2327,7 @@ export declare interface NS extends Singularity { * higher percentage increase from grow. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host 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; @@ -2835,7 +2338,7 @@ export declare interface NS extends Singularity { * (but it can go above 100). * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns Security level of the target server. */ getServerSecurityLevel(host: string): number; @@ -2850,7 +2353,7 @@ export declare interface NS extends Singularity { * installing an Augmentation(s). * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns Base security level of the target server. */ getServerBaseSecurityLevel(host: string): number; @@ -2859,7 +2362,7 @@ export declare interface NS extends Singularity { * Returns the minimum security level of the target server. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns Minimum security level of the target server. */ getServerMinSecurityLevel(host: string): number; @@ -2868,7 +2371,7 @@ export declare interface NS extends Singularity { * Returns the required hacking level of the target server. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns The required hacking level of the target server. */ getServerRequiredHackingLevel(host: string): number; @@ -2877,7 +2380,7 @@ export declare interface NS extends Singularity { * Returns the number of open ports required to successfully run NUKE.exe on the specified server. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns The number of open ports required to successfully run NUKE.exe on the specified server. */ getServerNumPortsRequired(host: string): number; @@ -2895,7 +2398,7 @@ export declare interface NS extends Singularity { * ramUsed = res[1]; * ``` * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns Array with total and used memory on the specified server. */ getServerRam(host: string): [number, number]; @@ -2904,7 +2407,7 @@ export declare interface NS extends Singularity { * Returns a boolean denoting whether or not the specified server exists. * * @remarks RAM cost: 0.1 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns True if specified server exists, and false otherwise. */ serverExists(host: string): boolean; @@ -2930,7 +2433,7 @@ export declare interface NS extends Singularity { * ``` * @remarks RAM cost: 0.1 GB * @param filename - Filename of file to check. - * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. + * @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; @@ -2956,7 +2459,7 @@ export declare interface NS extends Singularity { * ``` * @remarks RAM cost: 0.1 GB * @param script - Filename of script to check. This is case-sensitive. - * @param host - Host or IP of target server. + * @param host - Host of target server. * @param args - Arguments to specify/identify which scripts to search for. * @returns True if specified script is running on the target server, and false otherwise. */ @@ -3010,7 +2513,7 @@ export declare interface NS extends Singularity { * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). * @returns The hostname of the newly purchased server. */ - purchaseServer(hostname: string, ram: number): string | ""; + purchaseServer(hostname: string, ram: number): string; /** * Deletes one of your purchased servers, which is specified by its hostname. @@ -3070,7 +2573,7 @@ export declare interface NS extends Singularity { * @param data - Data to write. * @param mode - Defines the write mode. Only valid when writing to text files. */ - write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; + write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void; /** * Attempts to write data to the specified Netscript Port. @@ -3082,7 +2585,7 @@ export declare interface NS extends Singularity { * @param data - Data to write. * @returns True if the data is successfully written to the port, and false otherwise. */ - tryWrite(port: Handle, data: string | string[] | number): boolean; + tryWrite(port: Handle, data: string[] | number): boolean; /** * This function is used to read data from a port or from a text file (.txt). @@ -3133,7 +2636,7 @@ export declare interface NS extends Singularity { * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. * * @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports - * @remarks 10 GB + * @remarks RAM cost: 10 GB * @param port - Port number. Must be an integer between 1 and 20. * @returns Data in the specified port. */ @@ -3145,7 +2648,7 @@ export declare interface NS extends Singularity { * * @remarks RAM cost: 1 GB * @param name - Filename of file to remove. Must include the extension. - * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. + * @param host - Host Address of the server on which to delete the file. Optional. Defaults to current server. * @returns True if it successfully deletes the file, and false otherwise. */ rm(name: string, host?: string): boolean; @@ -3169,18 +2672,18 @@ export declare interface NS extends Singularity { * ``` * @remarks RAM cost: 1 GB * @param script - Filename of script to check. This is case-sensitive. - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns True if the specified script is running, and false otherwise. */ scriptRunning(script: string, host: string): boolean; /** - * Kills all scripts with the specified filename on the target server specified by hostname/ip, + * Kills all scripts with the specified filename on the target server specified by hostname, * regardless of arguments. * * @remarks RAM cost: 1 GB * @param script - Filename of script to kill. This is case-sensitive. - * @param host - Host or IP of target server. + * @param host - Host of target server. * @returns true if one or more scripts were successfully killed, and false if none were. */ scriptKill(script: string, host: string): boolean; @@ -3199,7 +2702,7 @@ export declare interface NS extends Singularity { * * @remarks RAM cost: 0.1 GB * @param script - Filename of script. This is case-sensitive. - * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. + * @param host - Host of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. */ getScriptRam(script: string, host?: string): number; @@ -3209,7 +2712,7 @@ export declare interface NS extends Singularity { * The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. * * @remarks RAM cost: 0.05 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. @@ -3221,7 +2724,7 @@ export declare interface NS extends Singularity { * The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. * * @remarks RAM cost: 0.05 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. @@ -3233,7 +2736,7 @@ export declare interface NS extends Singularity { * The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. * * @remarks RAM cost: 0.05 GB - * @param host - Host or IP of target server. + * @param host - Host of target server. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. @@ -3395,18 +2898,6 @@ export declare interface NS extends Singularity { getBitNodeMultipliers(): BitNodeMultipliers; } -/** - * All possible stock market order positions. - * @public - */ -export declare type OrderPosition = "long" | "short"; - -/** - * All possible stock market order type. - * @public - */ -export declare type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; - /** * Short summary of the players skills. * @public @@ -3440,7 +2931,7 @@ export declare interface PlayerSkills { * then you will lose all of the data in the ports! * @public */ -export declare type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; +export declare type Port = number; /** * A single process on a server. @@ -3455,21 +2946,6 @@ export declare interface ProcessInfo { args: string[]; } -/** - * All programs. - * @public - */ -export declare type Programs = -| "autolink.exe" -| "brutessh.exe" -| "deepscanv1.exe" -| "deepscanv2.exe" -| "ftpcrack.exe" -| "httpworm.exe" -| "relaysmtp.exe" -| "serverprofiler.exe" -| "sqlinject.exe"; - /** * A single server. * @public @@ -3523,11 +2999,18 @@ export declare interface Server { /** * Singularity API + * @remarks + * This API requires Source-File 4 level 1 / 2 / 3 to use. * @public */ export declare interface Singularity { /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Take university class. + * + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -3537,17 +3020,20 @@ export declare interface Singularity { * The cost and experience gains for all of these universities and classes are the same as * if you were to manually visit and take these classes. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param universityName - Name of university. You must be in the correct city for whatever university you specify. * @param courseName - Name of course. * @returns True if actions is successfully started, false otherwise. */ - universityCourse(universityName: University, courseName: UniversityCourse): boolean; + universityCourse(universityName: string, courseName: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - * + * Workout at the gym. + * + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -3556,42 +3042,48 @@ export declare interface Singularity { * The cost and experience gains for all of these gyms are the same as if you were * to manually visit these gyms and train * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify. * @param stat - The stat you want to train. * @returns True if actions is successfully started, false otherwise. */ - gymWorkout(gymName: Gym, stat: GymStat): boolean; + gymWorkout(gymName: string, stat: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Travel to another city. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param city - City to travel to. * @returns True if actions is successful, false otherwise. */ - travelToCity(city: City): boolean; + travelToCity(city: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase the TOR router. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @returns True if actions is successful, false otherwise. */ purchaseTor(): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase a program from the dark web. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -3602,55 +3094,32 @@ export declare interface Singularity { * ```ts * purchaseProgram("brutessh.exe"); * ``` - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param programName - Name of program to purchase. * @returns True if the specified program is purchased, and false otherwise. */ - purchaseProgram(programName: Programs): boolean; + purchaseProgram(programName: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Check if the player is busy. + * @remarks + * RAM cost: 0.5 GB * - * Returns an object with the Player’s stats. - * - * @example - * ```ts - * res = getStats(); - * print('My charisma level is: ' + res.charisma); - * ``` - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 - * @returns Object with the Player’s stats. - */ - getStats(): PlayerSkills; - - /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - * - * Returns an object with various information about your character. - * - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 - * @returns Object with various information about your character. - */ - getCharacterInformation(): CharacterInfo; - - /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Singularity - Level 1 * * Returns a boolean indicating whether or not the player is currently performing an * ‘action’. These actions include working for a company/faction, studying at a univeristy, * working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. * - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 * @returns True if the player is currently performing an ‘action’, false otherwise. */ isBusy(): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Stop the current action. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 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. @@ -3665,39 +3134,45 @@ export declare interface Singularity { * This function will return true if the player’s action was ended. * It will return false if the player was not performing an action when this function was called. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 1 * @returns True if the player’s action was ended, false if the player was not performing an action. */ stopAction(): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Upgrade home computer RAM. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will upgrade amount of RAM on the player’s home computer. The cost is * the same as if you were to do it manually. * * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise. */ upgradeHomeRam(): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the price of upgrading home RAM. + * @remarks + * RAM cost: 1.5 GB + * + * Singularity - Level 2 * * Returns the cost of upgrading the player’s home computer RAM. * - * @remarks RAM cost: 1.5 GB - * @remarks Singularity - Level 2 * @returns Cost of upgrading the player’s home computer RAM. */ getUpgradeHomeRamCost(): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Work for a company. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically set you to start working at the company * at which you are employed. If you are already in the middle of some “working” @@ -3718,15 +3193,17 @@ export declare interface Singularity { * } * //This way, your company reputation will be updated every minute. * ``` - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked * @returns True if the player starts working, and false otherwise. */ - workForCompany(companyName?: CompanyName): boolean; + workForCompany(companyName?: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Apply for a job at a company. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * 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 @@ -3737,78 +3214,90 @@ export declare interface Singularity { * and false otherwise. Note that if you are trying to use this function to * apply for a promotion and you don’t get one, it will return false. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param companyName - Name of company to apply to. * @param field - Field to which you want to apply. * @returns True if the player successfully get a job/promotion, and false otherwise. */ - applyToCompany(companyName: CompanyName, field: CompanyField): boolean; + applyToCompany(companyName: string, field: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company reputation. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function will return the amount of reputation you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of reputation you have at the specified company. */ - getCompanyRep(companyName: CompanyName): number; + getCompanyRep(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company favor. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function will return the amount of favor you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of favor you have at the specified company. */ - getCompanyFavor(companyName: CompanyName): number; + getCompanyFavor(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company favor gain. + * @remarks + * RAM cost: 0.75 GB + * + * Singularity - Level 2 * * This function will return the amount of favor you will gain for the specified * company when you reset by installing Augmentations. * - * @remarks RAM cost: 0.75 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. */ - getCompanyFavorGain(companyName: CompanyName): number; + getCompanyFavorGain(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * List all current faction invitations. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * Returns an array with the name of all Factions you currently have oustanding invitations from. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @returns Array with the name of all Factions you currently have oustanding invitations from. */ - checkFactionInvitations(): FactionName[]; + checkFactionInvitations(): string[]; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Join a faction. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically accept an invitation from a faction and join it. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to join. * @returns True if player joined the faction, and false otherwise. */ - joinFaction(faction: FactionName): boolean; + joinFaction(faction: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Work for a faction. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically set you to start working for the specified faction. * Obviously, you must be a member of the faction or else this function will fail. If @@ -3829,67 +3318,77 @@ export declare interface Singularity { * } * //This way, your faction reputation will be updated every minute. * ``` - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to work for. * @param workType - Type of work to perform for the faction. * @returns True if the player starts working, and false otherwise. */ - workForFaction(faction: FactionName, workType: FactionWork): boolean; + workForFaction(faction: string, workType: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction reputation. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function returns the amount of reputation you have for the specified faction. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to work for. * @returns Amount of reputation you have for the specified faction. */ - getFactionRep(faction: FactionName): number; + getFactionRep(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction favor. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function returns the amount of favor you have for the specified faction. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction. * @returns Amount of favor you have for the specified faction. */ - getFactionFavor(faction: FactionName): number; + getFactionFavor(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction favor gain. + * @remarks + * RAM cost: 0.75 GB + * + * Singularity - Level 2 * * This function returns the amount of favor you will gain for the specified * faction when you reset by installing Augmentations. * - * @remarks RAM cost: 0.75 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction. * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations. */ - getFactionFavorGain(faction: FactionName): number; + getFactionFavorGain(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Donate to a faction. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Attempts to donate money to the specified faction in exchange for reputation. * Returns true if you successfully donate the money, and false otherwise. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction to donate to. * @param amount - Amount of money to donate. * @returns True if the money was donated, and false otherwise. */ - donateToFaction(faction: FactionName, amount: number): boolean; + donateToFaction(faction: string, amount: number): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Create a program. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * 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 @@ -3914,15 +3413,17 @@ export declare interface Singularity { * ```ts * createProgram(“relaysmtp.exe”); * ``` - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param program - Name of program to create. * @returns True if you successfully start working on the specified program, and false otherwise. */ - createProgram(program: Programs): boolean; + createProgram(program: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Commit a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function is used to automatically attempt to commit crimes. * If you are already in the middle of some ‘working’ action (such @@ -3940,334 +3441,350 @@ export declare interface Singularity { * although the game sets a certain crime to be X amount of seconds, there is no * guarantee that your browser will follow that time limit. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime to attempt. * @returns True if you successfully start working on the specified program, and false otherwise. */ - commitCrime(crime: Crime): number; + commitCrime(crime: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get chance to successfully commit a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns your chance of success at commiting the specified crime. - * The chance is returned as a decimal (i.e. 60% would be returned as 0.6). * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime. - * @returns Chance of success at commiting the specified crime as a decimal. + * @returns Chance of success at commiting the specified crime. */ - getCrimeChance(crime: Crime): number; + getCrimeChance(crime: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get stats related to a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns the stats of the crime. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime. Not case-sensitive * @returns The stats of the crime. */ - getCrimeStats(crime: Crime): CrimeStats; + getCrimeStats(crime: string): CrimeStats; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of owned augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns an array containing the names (as strings) of all Augmentations you have. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. * @returns Array containing the names (as strings) of all Augmentations you have. */ - getOwnedAugmentations(purchased?: boolean): AugmentName[]; + getOwnedAugmentations(purchased?: boolean): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of acquired Source-Files. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns an array of source files * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @returns Array containing an object with number and level of the source file. */ getOwnedSourceFiles(): SourceFileLvl[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of augmentation available from a faction. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns an array containing the names (as strings) of all Augmentations * that are available from the specified faction. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction. * @returns Array containing the names of all Augmentations. */ - getAugmentationsFromFaction(faction: FactionName): AugmentName[]; + getAugmentationsFromFaction(faction: string): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the pre-requisite of an augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. * If there are no prerequisites, a blank array is returned. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param augName - Name of Augmentation. * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. */ - getAugmentationPrereq(augName: AugmentName): AugmentName[]; + getAugmentationPrereq(augName: string): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase an augmentation + * @remarks + * RAM cost: 5 GB * - * This function returns an array with two elements that gives the cost for - * the specified Augmentation. The first element in the returned array is the - * reputation requirement of the Augmentation, and the second element is the - * money cost. - * - * If an invalid Augmentation name is passed in for the augName argument, this - * function will return the array [-1, -1]. - * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 - * @param augName - Name of Augmentation. - * @returns Array with first element as a reputation requirement and second element as the money cost. - */ - getAugmentationCost(augName: AugmentName): [number, number]; - - /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Singularity - Level 3 * * This function will try to purchase the specified Augmentation through the given Faction. * * This function will return true if the Augmentation is successfully purchased, and false otherwise. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction to purchase Augmentation from. - * @param augmnet - Name of Augmentation to purchase. + * @param augmentation - Name of Augmentation to purchase. * @returns True if the Augmentation is successfully purchased, and false otherwise. */ - purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; + purchaseAugmentation(faction: string, augmentation: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the stats of an augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns augmentation stats. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param name - Name of Augmentation. CASE-SENSITIVE. * @returns Augmentation stats. */ - getAugmentationStats(name: AugmentName): AugmentationStats; + getAugmentationStats(name: string): AugmentationStats; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Install your purchased augmentations. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function will automatically install your Augmentations, resetting the game as usual. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 - * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + * @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; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Soft reset the game. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function will perform a reset even if you don’t have any augmentation installed. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 */ softReset(): void; } /** * 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 { /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get the number of sleeves you own. + * @remarks + * RAM cost: 4 GB * * Return the number of duplicate sleeves the player has. * - * @remarks RAM cost: 4 GB * @returns number of duplicate sleeves the player has. */ getNumSleeves(): number; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get the stats of a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a structure containing the stats of the sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to get stats of. * @returns Object containing the stats of the sleeve. */ getSleeveStats(sleeveNumber: number): SleeveSkills; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get information about a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a struct containing tons of information about this sleeve * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve information. * @returns Object containing tons of information about this sleeve. */ getInformation(sleeveNumber: number): SleeveInformation; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get task of a sleeve. + * @remarks + * RAM cost: 4 GB * * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve task from. * @returns Object containing information the current task that the sleeve is performing. */ getTask(sleeveNumber: number): SleeveTask; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to shock recovery. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start recovery. * @returns True if this action was set successfully, false otherwise. */ setToShockRecovery(sleeveNumber: number): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to synchronize. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start synchronizing. * @returns True if this action was set successfully, false otherwise. */ setToSynchronize(sleeveNumber: number): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to commit crime. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * * Returns false if an invalid action is specified. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start commiting crime. * @param name - Name of the crime. Must be an exact match. * @returns True if this action was set successfully, false otherwise. */ - setToCommitCrime(sleeveNumber: number, name: Crime): boolean; + setToCommitCrime(sleeveNumber: number, name: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to work for the faction. * @param factionName - Name of the faction to work for. * @param factionWorkType - Name of the action to perform for this faction. * @returns True if the sleeve started working on this faction, false otherwise. */ - setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; + setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to work for the company. * @param companyName - Name of the company to work for. * @returns True if the sleeve started working on this company, false otherwise. */ - setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; + setToCompanyWork(sleeveNumber: number, companyName: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start taking class. * @param university - Name of the university to attend. * @param className - Name of the class to follow. * @returns True if this action was set successfully, false otherwise. */ - setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; + setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to workout at the gym. * @param gymName - Name of the gym. * @param stat - Name of the stat to train. * @returns True if the sleeve started working out, false otherwise. */ - setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; + setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Make a sleeve travel to another city. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not the sleeve reached destination. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to travel. * @param cityName - Name of the destination city. * @returns True if the sleeve reached destination, false otherwise. */ - travel(sleeveNumber: number, cityName: City): boolean; + travel(sleeveNumber: number, cityName: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get augmentations installed on a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a list of augmentation names that this sleeve has installed. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve augmentations from. * @returns List of augmentation names that this sleeve has installed. */ - getSleeveAugmentations(sleeveNumber: number): AugmentName[]; + getSleeveAugmentations(sleeveNumber: number): string[]; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * List purchasable augs for a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a list of augmentations that the player can buy for this sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from. * @returns List of augmentations that the player can buy for this sleeve. */ getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Purchase an aug for a sleeve. + * @remarks + * RAM cost: 4 GB * * Return true if the aug was purchased and installed on the sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to buy an aug for. * @param augName - Name of the aug to buy. Must be an exact match. * @returns True if the aug was purchased and installed on the sleeve, false otherwise. */ - purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; + purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; } /** @@ -4276,7 +3793,7 @@ export declare interface Sleeve { */ export declare interface SleeveInformation { /** location of the sleeve */ - city: City; + city: string; /** current hp of the sleeve */ hp: number; /** max hp of the sleeve */ @@ -4284,7 +3801,7 @@ export declare interface SleeveInformation { /** jobs available to the sleeve */ jobs: string[]; /** job titles available to the sleeve */ - jobTitle: CompanyField[]; + jobTitle: string[]; /** does this sleeve have access to the tor router */ tor: boolean; /** sleeve multipliers */ @@ -4332,13 +3849,13 @@ export declare interface SleeveTask { /** task type */ task: string; /** crime currently attempting, if any */ - crime: Crime | ""; + crime: string; /** location of the task, if any */ - location: City | ""; + location: string; /** stat being trained at the gym, if any */ - gymStatType: GymStat | ""; + gymStatType: string; /** faction work type being performed, if any */ - factionWorkType: FactionWork | ""; + factionWorkType: string; } /** @@ -4366,7 +3883,7 @@ export declare interface SleeveWorkGains { */ export declare interface SourceFileLvl { /** The number of the source file */ - n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; + n: number; /** The level of the source file */ lvl: number; } @@ -4377,7 +3894,7 @@ export declare interface SourceFileLvl { */ export declare type StockOrder = { /** Stock Symbol */ - [key in StockSymbol]?: StockOrderObject[]; + [key: string]: StockOrderObject[]; }; /** @@ -4390,49 +3907,78 @@ export declare interface StockOrderObject { /** Price per share */ price: number; /** Order type */ - type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; + type: string; /** Order position */ - position: "S" | "L"; + position: string; } /** - * All possible stock market symbols. + * Object representing data representing a gang member task. * @public */ -export declare type StockSymbol = -| "ECP" -| "MGCP" -| "BLD" -| "CLRK" -| "OMTK" -| "FSIG" -| "KGI" -| "FLCM" -| "STM" -| "DCOMM" -| "HLS" -| "VITA" -| "ICRS" -| "UNV" -| "AERO" -| "OMN" -| "SLRS" -| "GPH" -| "NVMD" -| "WDS" -| "LXO" -| "RHOC" -| "APHE" -| "SYSC" -| "CTK" -| "NTLK" -| "OMGA" -| "FNS" -| "SGC" -| "JGN" -| "CTYS" -| "MDYN" -| "TITN"; +export declare interface stringStats { + /** 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; + /** Stength skill impact on task scaling */ + strWeight: number; + /** Defense skill impact on task scaling */ + defWeight: number; + /** Dexterity skill impact on task scaling */ + dexWeight: number; + /** Agility skill impact on task scaling */ + agiWeight: number; + /** Charisma skill impact on task scaling */ + chaWeight: number; + /** Number representing the difficulty of the task */ + difficulty: number; + /** Territory impact on task scaling */ + territory: stringTerritory; +} + +/** + * Object representing data representing a gang member equipment. + * @public + */ +export declare interface stringStats { + /** Strength multiplier */ + str: number; + /** Defense multiplier */ + def: number; + /** Dexterity multiplier */ + dex: number; + /** Agility multiplier */ + agi: number; + /** Charisma multiplier */ + cha: number; + /** Hacking multiplier */ + hack: number; +} + +/** + * @public + */ +export declare interface stringTerritory { + /** Money gain impact on task scaling */ + money: number; + /** Respect gain impact on task scaling */ + respect: number; + /** Wanted gain impact on task scaling */ + wanted: number; +} /** * Stock market API @@ -4445,7 +3991,7 @@ export declare interface TIX { * @remarks RAM cost: 2 GB * @returns Array of the symbols of the tradable stocks. */ - getSymbols(): StockSymbol[]; + getSymbols(): string[]; /** * Returns the price of a stock @@ -4461,7 +4007,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns The price of a stock. */ - getPrice(sym: StockSymbol): number; + getPrice(sym: string): number; /** * Returns the ask price of that stock. @@ -4470,7 +4016,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns The ask price of a stock. */ - getAskPrice(sym: StockSymbol): number; + getAskPrice(sym: string): number; /** * Returns the bid price of that stock. @@ -4479,7 +4025,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns The bid price of a stock. */ - getBidPrice(sym: StockSymbol): number; + getBidPrice(sym: string): number; /** * Returns the player’s position in a stock. @@ -4508,7 +4054,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns Array of four elements that represents the player’s position in a stock. */ - getPosition(sym: StockSymbol): [number, number, number, number]; + getPosition(sym: string): [number, number, number, number]; /** * Returns the maximum number of shares of a stock. @@ -4520,7 +4066,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns Maximum number of shares that the stock has. */ - getMaxShares(sym: StockSymbol): number; + getMaxShares(sym: string): number; /** * Calculates cost of buying stocks. @@ -4534,7 +4080,7 @@ export declare interface TIX { * @param posType - Specifies whether the order is a “Long” or “Short” position. * @returns Cost to buy a given number of shares of a stock. */ - getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPosition): number; + getPurchaseCost(sym: string, shares: number, posType: string): number; /** * Calculate profit of setting stocks. @@ -4548,7 +4094,7 @@ export declare interface TIX { * @param posType - Specifies whether the order is a “Long” or “Short” position. * @returns Gain from selling a given number of shares of a stock. */ - getSaleGain(sym: StockSymbol, shares: number, posType: OrderPosition): number; + getSaleGain(sym: string, shares: number, posType: string): number; /** * Buy stocks. @@ -4567,7 +4113,7 @@ export declare interface TIX { * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ - buy(sym: StockSymbol, shares: number): number; + buy(sym: string, shares: number): number; /** * Sell stocks. @@ -4591,7 +4137,7 @@ export declare interface TIX { * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ - sell(sym: StockSymbol, shares: number): number; + sell(sym: string, shares: number): number; /** * Short stocks. @@ -4613,7 +4159,7 @@ export declare interface TIX { * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ - short(sym: StockSymbol, shares: number): number; + short(sym: string, shares: number): number; /** * Sell short stock. @@ -4635,7 +4181,7 @@ export declare interface TIX { * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ - sellShort(sym: StockSymbol, shares: number): number; + sellShort(sym: string, shares: number): number; /** * Place order for stocks. @@ -4655,7 +4201,7 @@ export declare interface TIX { * @param pos - Specifies whether the order is a “Long” or “Short” position. * @returns True if the order is successfully placed, and false otherwise. */ - placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): boolean; + placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean; /** * Cancel order for stocks. @@ -4672,7 +4218,7 @@ export declare interface TIX { * @param type - Type of order. * @param pos - Specifies whether the order is a “Long” or “Short” position. */ - cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): void; + cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void; /** * Returns your order book for the stock market. @@ -4683,7 +4229,7 @@ export declare interface TIX { * * ```ts * { - * StockSymbol1: [ // Array of orders for this stock + * string1: [ // Array of orders for this stock * { * shares: Order quantity * price: Order price @@ -4695,7 +4241,7 @@ export declare interface TIX { * }, * ... * ], - * StockSymbol2: [ // Array of orders for this stock + * string2: [ // Array of orders for this stock * ... * ], * ... @@ -4749,7 +4295,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns Volatility of the specified stock. */ - getVolatility(sym: StockSymbol): number; + getVolatility(sym: string): number; /** * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. @@ -4766,7 +4312,7 @@ export declare interface TIX { * @param sym - Stock symbol. * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. */ - getForecast(sym: StockSymbol): number; + getForecast(sym: string): number; /** * Purchase 4S Market Data Access. @@ -4783,22 +4329,4 @@ export declare interface TIX { purchase4SMarketDataTixApi(): boolean; } -/** - * All universities. - * @public - */ -export declare type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; - -/** - * All university courses. - * @public - */ -export declare type UniversityCourse = -| "Study Computer Science" -| "Data Strucures" -| "Networks" -| "Algorithms" -| "Management" -| "Leadership"; - export { } diff --git a/input/bitburner.api.json b/input/bitburner.api.json index fb5a3a1a0..49a22b191 100644 --- a/input/bitburner.api.json +++ b/input/bitburner.api.json @@ -965,31 +965,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!AugmentName:type", - "docComment": "/**\n * All augmentation names.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type AugmentName =\n " - }, - { - "kind": "Content", - "text": "| \"Augmented Targeting I\"\n | \"Augmented Targeting II\"\n | \"Augmented Targeting III\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"Combat Rib I\"\n | \"Combat Rib II\"\n | \"Combat Rib III\"\n | \"Nanofiber Weave\"\n | \"NEMEAN Subdermal Weave\"\n | \"Wired Reflexes\"\n | \"Graphene Bone Lacings\"\n | \"Bionic Spine\"\n | \"Graphene Bionic Spine Upgrade\"\n | \"Bionic Legs\"\n | \"Graphene Bionic Legs Upgrade\"\n | \"Speech Processor Implant\"\n | \"TITN-41 Gene-Modification Injection\"\n | \"Enhanced Social Interaction Implant\"\n | \"BitWire\"\n | \"Artificial Bio-neural Network Implant\"\n | \"Artificial Synaptic Potentiation\"\n | \"Enhanced Myelin Sheathing\"\n | \"Synaptic Enhancement Implant\"\n | \"Neural-Retention Enhancement\"\n | \"DataJack\"\n | \"Embedded Netburner Module\"\n | \"Embedded Netburner Module Core Implant\"\n | \"Embedded Netburner Module Core V2 Upgrade\"\n | \"Embedded Netburner Module Core V3 Upgrade\"\n | \"Embedded Netburner Module Analyze Engine\"\n | \"Embedded Netburner Module Direct Memory Access Upgrade\"\n | \"Neuralstimulator\"\n | \"Neural Accelerator\"\n | \"Cranial Signal Processors - Gen I\"\n | \"Cranial Signal Processors - Gen II\"\n | \"Cranial Signal Processors - Gen III\"\n | \"Cranial Signal Processors - Gen IV\"\n | \"Cranial Signal Processors - Gen V\"\n | \"Neuronal Densification\"\n | \"Nuoptimal Nootropic Injector Implant\"\n | \"Speech Enhancement\"\n | \"FocusWire\"\n | \"PC Direct-Neural Interface\"\n | \"PC Direct-Neural Interface Optimization Submodule\"\n | \"PC Direct-Neural Interface NeuroNet Injector\"\n | \"ADR-V1 Pheromone Gene\"\n | \"ADR-V2 Pheromone Gene\"\n | \"The Shadow's Simulacrum\"\n | \"Hacknet Node CPU Architecture Neural-Upload\"\n | \"Hacknet Node Cache Architecture Neural-Upload\"\n | \"Hacknet Node NIC Architecture Neural-Upload\"\n | \"Hacknet Node Kernel Direct-Neural Interface\"\n | \"Hacknet Node Core Direct-Neural Interface\"\n | \"NeuroFlux Governor\"\n | \"Neurotrainer I\"\n | \"Neurotrainer II\"\n | \"Neurotrainer III\"\n | \"HyperSight Corneal Implant\"\n | \"LuminCloaking-V1 Skin Implant\"\n | \"LuminCloaking-V2 Skin Implant\"\n | \"HemoRecirculator\"\n | \"SmartSonar Implant\"\n | \"Power Recirculation Core\"\n | \"QLink\"\n | \"The Red Pill\"\n | \"SPTN-97 Gene Modification\"\n | \"ECorp HVMind Implant\"\n | \"CordiARC Fusion Reactor\"\n | \"SmartJaw\"\n | \"Neotra\"\n | \"Xanipher\"\n | \"nextSENS Gene Modification\"\n | \"OmniTek InfoLoad\"\n | \"Photosynthetic Cells\"\n | \"BitRunners Neurolink\"\n | \"The Black Hand\"\n | \"CRTX42-AA Gene Modification\"\n | \"Neuregen Gene Modification\"\n | \"CashRoot Starter Kit\"\n | \"NutriGen Implant\"\n | \"INFRARET Enhancement\"\n | \"DermaForce Particle Barrier\"\n | \"Graphene BranchiBlades Upgrade\"\n | \"Graphene Bionic Arms Upgrade\"\n | \"BrachiBlades\"\n | \"Bionic Arms\"\n | \"Social Negotiation Assistant (S.N.A)\"\n | \"EsperTech Bladeburner Eyewear\"\n | \"EMS-4 Recombination\"\n | \"ORION-MKIV Shoulder\"\n | \"Hyperion Plasma Cannon V1\"\n | \"Hyperion Plasma Cannon V2\"\n | \"GOLEM Serum\"\n | \"Vangelis Virus\"\n | \"Vangelis Virus 3.0\"\n | \"I.N.T.E.R.L.I.N.K.E.D\"\n | \"Blade's Runners\"\n | \"BLADE-51b Tesla Armor\"\n | \"BLADE-51b Tesla Armor: Power Cells Upgrade\"\n | \"BLADE-51b Tesla Armor: Energy Shielding Upgrade\"\n | \"BLADE-51b Tesla Armor: Unibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: Omnibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: IPU Upgrade\"\n | \"The Blade's Simulacrum\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "AugmentName", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!AugmentPair:interface", @@ -1039,9 +1014,8 @@ "text": "name: " }, { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -2160,7 +2134,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!Bladeburner:interface", - "docComment": "/**\n * @public\n */\n", + "docComment": "/**\n * Bladeburner API\n *\n * @remarks\n *\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this API.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2173,56 +2147,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionAutolevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Return a boolean indicating whether or not this action is currently set to autolevel.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns True if the action is set to autolevel, and false otherwise.\n */\n", + "docComment": "/**\n * Get wether an action is set to autolevel.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not this action is currently set to autolevel.\n *\n * Returns false if an invalid action is specified.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns True if the action is set to autolevel, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionAutolevel(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionAutolevel(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2235,8 +2180,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2252,7 +2197,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2261,56 +2206,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionCountRemaining:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the remaining count of the specified action.\n *\n * Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Remaining count of the specified action.\n */\n", + "docComment": "/**\n * Get action count remaining.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the remaining count of the specified action.\n *\n * Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Remaining count of the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionCountRemaining(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionCountRemaining(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2323,8 +2239,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2340,7 +2256,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2349,56 +2265,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionCurrentLevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the current level of this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Current level of the specified action.\n */\n", + "docComment": "/**\n * Get the current level of an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the current level of this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Current level of the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionCurrentLevel(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionCurrentLevel(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2411,8 +2298,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2428,7 +2315,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2437,56 +2324,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionEstimatedSuccessChance:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Estimated success chance for the specified action.\n */\n", + "docComment": "/**\n * Get estimate success chance of an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Estimated success chance for the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionEstimatedSuccessChance(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionEstimatedSuccessChance(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2499,8 +2357,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2516,7 +2374,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2525,56 +2383,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionMaxLevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the maximum level for this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Maximum level of the specified action.\n */\n", + "docComment": "/**\n * Get the maximum level of an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the maximum level for this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Maximum level of the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionMaxLevel(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionMaxLevel(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2587,8 +2416,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2604,7 +2433,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2613,56 +2442,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionRepGain:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Optional action level at which to calculate the gain\n *\n * @returns Average Bladeburner reputation gain for successfully completing the specified action.\n */\n", + "docComment": "/**\n * Get the reputation gain of an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Optional action level at which to calculate the gain\n *\n * @returns Average Bladeburner reputation gain for successfully completing the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionRepGain(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionRepGain(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n level: " + "text": ", level: " }, { "kind": "Content", @@ -2670,7 +2470,7 @@ }, { "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2683,8 +2483,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2700,14 +2500,14 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } }, { "parameterName": "level", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 } } ], @@ -2716,56 +2516,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getActionTime:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of seconds it takes to complete the specified action\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of seconds it takes to complete the specified action.\n */\n", + "docComment": "/**\n * Get the time to complete an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the number of seconds it takes to complete the specified action\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of milliseconds it takes to complete the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getActionTime(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getActionTime(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -2778,8 +2549,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2795,7 +2566,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -2804,20 +2575,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getBlackOpNames:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner Black Ops.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner Black Ops.\n */\n", + "docComment": "/**\n * List all black ops.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * Returns an array of strings containing the names of all Bladeburner Black Ops.\n *\n * @returns Array of strings containing the names of all Bladeburner Black Ops.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBlackOpNames(): " }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -2827,7 +2593,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -2837,16 +2603,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getBlackOpRank:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the rank required to complete this BlackOp.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param name - Name of BlackOp. Must be an exact match.\n *\n * @returns Rank required to complete this BlackOp.\n */\n", + "docComment": "/**\n * Get black op required rank.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Returns the rank required to complete this BlackOp.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @param name - Name of BlackOp. Must be an exact match.\n *\n * @returns Rank required to complete this BlackOp.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getBlackOpRank(name: " }, { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -2882,7 +2647,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getBonusTime:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n */\n", + "docComment": "/**\n * Get bladeburner bonus time.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.\n *\n * @returns Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2910,16 +2675,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getCity:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the city that the player is currently in (for Bladeburner).\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns City that the player is currently in (for Bladeburner).\n */\n", + "docComment": "/**\n * Get current city.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the city that the player is currently in (for Bladeburner).\n *\n * @returns City that the player is currently in (for Bladeburner).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCity(): " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -2939,16 +2703,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getCityChaos:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the chaos in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Chaos in the specified city.\n */\n", + "docComment": "/**\n * Get chaos of a city.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the chaos in the specified city, or -1 if an invalid city was specified.\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Chaos in the specified city.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCityChaos(name: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -2984,16 +2747,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getCityCommunities:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Number of Synthoids communities in the specified city.\n */\n", + "docComment": "/**\n * Get number of communities in a city.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Number of Synthoids communities in the specified city.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCityCommunities(name: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -3029,16 +2791,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getCityEstimatedPopulation:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Estimated number of Synthoids in the specified city.\n */\n", + "docComment": "/**\n * Get estimated population in city.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Estimated number of Synthoids in the specified city.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCityEstimatedPopulation(name: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -3074,20 +2835,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getContractNames:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner contracts.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner contracts.\n */\n", + "docComment": "/**\n * List all contracts.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * Returns an array of strings containing the names of all Bladeburner contracts.\n *\n * @returns Array of strings containing the names of all Bladeburner contracts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getContractNames(): " }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -3097,7 +2853,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3107,7 +2863,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getCurrentAction:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @returns Object that represents the player’s current Bladeburner action.\n */\n", + "docComment": "/**\n * Get current action.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.\n *\n * @returns Object that represents the player’s current Bladeburner action.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3136,20 +2892,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getGeneralActionNames:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner actions.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner actions.\n */\n", + "docComment": "/**\n * List all general actions.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * Returns an array of strings containing the names of all general Bladeburner actions.\n *\n * @returns Array of strings containing the names of all general Bladeburner actions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getGeneralActionNames(): " }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -3159,7 +2910,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3169,20 +2920,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getOperationNames:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner operations.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner operations.\n */\n", + "docComment": "/**\n * List all operations.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * Returns an array of strings containing the names of all Bladeburner operations.\n *\n * @returns Array of strings containing the names of all Bladeburner operations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getOperationNames(): " }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -3192,7 +2938,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3202,7 +2948,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getRank:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the player’s Bladeburner Rank.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns Player’s Bladeburner Rank.\n */\n", + "docComment": "/**\n * Get player bladeburner rank.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the player’s Bladeburner Rank.\n *\n * @returns Player’s Bladeburner Rank.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3230,16 +2976,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getSkillLevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns your level in the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Level in the specified skill.\n */\n", + "docComment": "/**\n * Get skill level.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * This function returns your level in the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Level in the specified skill.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSkillLevel(name: " }, { - "kind": "Reference", - "text": "BladeburnerSkills", - "canonicalReference": "bitburner!BladeburnerSkills:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -3275,20 +3020,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getSkillNames:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner skills.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner skills.\n */\n", + "docComment": "/**\n * List all skills.\n *\n * @remarks\n *\n * RAM cost: 0.4 GB\n *\n * Returns an array of strings containing the names of all general Bladeburner skills.\n *\n * @returns Array of strings containing the names of all general Bladeburner skills.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSkillNames(): " }, - { - "kind": "Reference", - "text": "BladeburnerSkills", - "canonicalReference": "bitburner!BladeburnerSkills:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -3298,7 +3038,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3308,7 +3048,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getSkillPoints:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner skill points you have.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns Number of Bladeburner skill points you have.\n */\n", + "docComment": "/**\n * Get bladeburner skill points.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the number of Bladeburner skill points you have.\n *\n * @returns Number of Bladeburner skill points you have.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3336,16 +3076,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getSkillUpgradeCost:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns the number of skill points needed to upgrade the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Number of skill points needed to upgrade the specified skill.\n */\n", + "docComment": "/**\n * Get cost to upgrade skill.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * This function returns the number of skill points needed to upgrade the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Number of skill points needed to upgrade the specified skill.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSkillUpgradeCost(name: " }, { - "kind": "Reference", - "text": "BladeburnerSkills", - "canonicalReference": "bitburner!BladeburnerSkills:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -3381,7 +3120,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getStamina:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array with two elements: * [Current stamina, Max stamina]\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns Array containing current stamina and max stamina.\n *\n * @example\n * ```ts\n * function getStaminaPercentage() {\n * let res = bladeburner.getStamina();\n * return res[0] / res[1];\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Get bladeburner stamina.\n *\n * @remarks\n *\n * RAM cost: 4 GB Returns an array with two elements: * [Current stamina, Max stamina]\n *\n * @returns Array containing current stamina and max stamina.\n *\n * @example\n * ```ts\n * function getStaminaPercentage() {\n * let res = bladeburner.getStamina();\n * return res[0] / res[1];\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3409,56 +3148,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#getTeamSize:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner team members you have assigned to the specified action.\n *\n * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of Bladeburner team members that were assigned to the specified action.\n */\n", + "docComment": "/**\n * Get team size.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the number of Bladeburner team members you have assigned to the specified action.\n *\n * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of Bladeburner team members that were assigned to the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getTeamSize(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "getTeamSize(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -3471,8 +3181,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3488,7 +3198,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -3497,7 +3207,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#joinBladeburnerDivision:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner division.\n *\n * Returns true if you successfully join the Bladeburner division, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise.\n */\n", + "docComment": "/**\n * Join the bladeburner division.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Attempts to join the Bladeburner division.\n *\n * Returns true if you successfully join the Bladeburner division, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3525,7 +3235,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#joinBladeburnerFaction:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner faction.\n *\n * Returns true if you successfully join the Bladeburner faction, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise.\n */\n", + "docComment": "/**\n * Join the bladeburner faction.\n *\n * @remarks\n *\n * RAM cost: 4 GB Attempts to join the Bladeburner faction.\n *\n * Returns true if you successfully join the Bladeburner faction, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3553,56 +3263,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#setActionAutolevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Enable/disable autoleveling for the specified action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param autoLevel - Whether or not to autolevel this action\n */\n", + "docComment": "/**\n * Set an action autolevel.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Enable/disable autoleveling for the specified action.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param autoLevel - Whether or not to autolevel this action\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "setActionAutolevel(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "setActionAutolevel(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n autoLevel: " + "text": ", autoLevel: " }, { "kind": "Content", @@ -3610,7 +3291,7 @@ }, { "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -3623,8 +3304,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3640,14 +3321,14 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } }, { "parameterName": "autoLevel", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3656,56 +3337,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#setActionLevel:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the level for the specified action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Level to set this action to.\n */\n", + "docComment": "/**\n * Set the level of an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Set the level for the specified action.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Level to set this action to.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "setActionLevel(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "setActionLevel(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n level: " + "text": ", level: " }, { "kind": "Content", @@ -3713,7 +3365,7 @@ }, { "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -3726,8 +3378,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3743,14 +3395,14 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } }, { "parameterName": "level", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3759,56 +3411,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#setTeamSize:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the team size for the specified Bladeburner action.\n *\n * Returns the team size that was set, or -1 if the function failed.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param size - Number of team members to set. Will be converted using Math.round().\n *\n * @returns Number of Bladeburner team members you assigned to the specified action.\n */\n", + "docComment": "/**\n * Set team size.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Set the team size for the specified Bladeburner action.\n *\n * Returns the team size that was set, or -1 if the function failed.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param size - Number of team members to set. Will be converted using Math.round().\n *\n * @returns Number of Bladeburner team members you assigned to the specified action.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "setTeamSize(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "setTeamSize(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n size: " + "text": ", size: " }, { "kind": "Content", @@ -3816,7 +3439,7 @@ }, { "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -3829,8 +3452,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3846,14 +3469,14 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } }, { "parameterName": "size", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3862,56 +3485,27 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#startAction:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match\n *\n * @returns True if the action was started successfully, and false otherwise.\n */\n", + "docComment": "/**\n * Start an action.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match\n *\n * @returns True if the action was started successfully, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "startAction(\n type: " - }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" + "text": "startAction(type: " }, { "kind": "Content", - "text": ",\n name: " - }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" + "text": ", name: " }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" + "text": "string" }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" - }, - { - "kind": "Content", - "text": ",\n ): " + "text": "): " }, { "kind": "Content", @@ -3924,8 +3518,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -3941,7 +3535,7 @@ "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 10 + "endIndex": 4 } } ], @@ -3950,7 +3544,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#stopBladeburnerAction:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Stops the current Bladeburner action.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n */\n", + "docComment": "/**\n * Stop current action.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Stops the current Bladeburner action.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3978,16 +3572,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#switchCity:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to switch to the specified city (for Bladeburner only).\n *\n * Returns true if successful, and false otherwise\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns true if successful, and false otherwise\n */\n", + "docComment": "/**\n * Travel to another city in bladeburner.\n *\n * @remarks\n *\n * RAM cost: 4 GB Attempts to switch to the specified city (for Bladeburner only).\n *\n * Returns true if successful, and false otherwise\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns true if successful, and false otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "switchCity(name: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -4023,16 +3616,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Bladeburner#upgradeSkill:member(1)", - "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to upgrade the specified Bladeburner skill.\n *\n * Returns true if the skill is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match\n *\n * @returns true if the skill is successfully upgraded, and false otherwise.\n */\n", + "docComment": "/**\n * Upgrade skill.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Attempts to upgrade the specified Bladeburner skill.\n *\n * Returns true if the skill is successfully upgraded, and false otherwise.\n *\n * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match\n *\n * @returns true if the skill is successfully upgraded, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "upgradeSkill(name: " }, { - "kind": "Reference", - "text": "BladeburnerSkills", - "canonicalReference": "bitburner!BladeburnerSkills:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -4068,81 +3660,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerActTypes:type", - "docComment": "/**\n * All Bladeburner action types.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerActTypes = " - }, - { - "kind": "Content", - "text": "\"contracts\" | \"operations\" | \"black ops\" | \"general\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerActTypes", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerBlackOps:type", - "docComment": "/**\n * All Bladeburner black ops.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerBlackOps =\n " - }, - { - "kind": "Content", - "text": "| \"Operation Typhoon\"\n | \"Operation Zero\"\n | \"Operation X\"\n | \"Operation Titan\"\n | \"Operation Ares\"\n | \"Operation Archangel\"\n | \"Operation Juggernaut\"\n | \"Operation Red Dragon\"\n | \"Operation K\"\n | \"Operation Deckard\"\n | \"Operation Tyrell\"\n | \"Operation Wallace\"\n | \"Operation Shoulder of Orion\"\n | \"Operation Hyron\"\n | \"Operation Morpheus\"\n | \"Operation Ion Storm\"\n | \"Operation Annihilus\"\n | \"Operation Ultron\"\n | \"Operation Centurion\"\n | \"Operation Vindictus\"\n | \"Operation Daedalus\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerBlackOps", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerContracts:type", - "docComment": "/**\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerContracts = " - }, - { - "kind": "Content", - "text": "\"Tracking\" | \"Bounty Hunter\" | \"Retirement\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerContracts", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!BladeburnerCurAction:interface", @@ -4165,37 +3682,9 @@ "kind": "Content", "text": "name: " }, - { - "kind": "Reference", - "text": "BladeburnerGenActions", - "canonicalReference": "bitburner!BladeburnerGenActions:type" - }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerContracts", - "canonicalReference": "bitburner!BladeburnerContracts:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerOperations", - "canonicalReference": "bitburner!BladeburnerOperations:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "BladeburnerBlackOps", - "canonicalReference": "bitburner!BladeburnerBlackOps:type" + "text": "string" }, { "kind": "Content", @@ -4207,7 +3696,7 @@ "name": "name", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 8 + "endIndex": 2 } }, { @@ -4219,14 +3708,9 @@ "kind": "Content", "text": "type: " }, - { - "kind": "Reference", - "text": "BladeburnerActTypes", - "canonicalReference": "bitburner!BladeburnerActTypes:type" - }, { "kind": "Content", - "text": " | \"Idle\"" + "text": "string" }, { "kind": "Content", @@ -4238,87 +3722,12 @@ "name": "type", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } } ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerGenActions:type", - "docComment": "/**\n * All Bladeburner General Actions.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerGenActions =\n " - }, - { - "kind": "Content", - "text": "| \"Training\"\n | \"Field Analysis\"\n | \"Recruitment\"\n | \"Diplomacy\"\n | \"Hyperbolic Regeneration Chamber\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerGenActions", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerOperations:type", - "docComment": "/**\n * All Bladeburner Ops.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerOperations =\n " - }, - { - "kind": "Content", - "text": "| \"Investigation\"\n | \"Undercover Operation\"\n | \"Sting Operation\"\n | \"Raid\"\n | \"Stealth Retirement Operation\"\n | \"Assassination\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerOperations", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!BladeburnerSkills:type", - "docComment": "/**\n * All Bladeburner Skills.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type BladeburnerSkills =\n " - }, - { - "kind": "Content", - "text": "| \"Blade's Intuition\"\n | \"Cloak\"\n | \"Marksman\"\n | \"Weapon Proficiency\"\n | \"Short-Circuit\"\n | \"Digital Observer\"\n | \"Tracer\"\n | \"Overclock\"\n | \"Reaper\"\n | \"Evasive System\"\n | \"Datamancer\"\n | \"Cyber's Edge\"\n | \"Hands of Midas\"\n | \"Hyperdrive\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "BladeburnerSkills", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!CharacterInfo:interface", @@ -4368,9 +3777,8 @@ "text": "city: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -4394,14 +3802,9 @@ "kind": "Content", "text": "company: " }, - { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -4413,7 +3816,7 @@ "name": "company", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -4425,14 +3828,9 @@ "kind": "Content", "text": "factions: " }, - { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -4444,7 +3842,7 @@ "name": "factions", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -4482,14 +3880,9 @@ "kind": "Content", "text": "jobTitle: " }, - { - "kind": "Reference", - "text": "CompanyField", - "canonicalReference": "bitburner!CompanyField:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -4501,7 +3894,7 @@ "name": "jobTitle", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -5226,31 +4619,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!City:type", - "docComment": "/**\n * All cities.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type City = " - }, - { - "kind": "Content", - "text": "\"Aevum\" | \"Chongqing\" | \"Sector-12\" | \"New Tokyo\" | \"Ishima\" | \"Volhaven\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "City", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!CodingAttemptOptions:interface", @@ -5309,7 +4677,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#attempt:member(1)", - "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns True if the solution was correct, false otherwise.\n */\n", + "docComment": "/**\n * Attemps a coding contract.\n *\n * @remarks\n *\n * RAM cost: 10 GB\n *\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns True if the solution was correct, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5317,7 +4685,7 @@ }, { "kind": "Content", - "text": "string | string[] | number" + "text": "string[] | number" }, { "kind": "Content", @@ -5383,7 +4751,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#attempt:member(2)", - "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.\n */\n", + "docComment": "/**\n * Attemps a coding contract.\n *\n * @remarks\n *\n * RAM cost: 10 GB\n *\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5391,7 +4759,7 @@ }, { "kind": "Content", - "text": "string | string[] | number" + "text": "string[] | number" }, { "kind": "Content", @@ -5473,7 +4841,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#getContractType:member(1)", - "docComment": "/**\n * Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Name describing the type of problem posed by the Coding Contract.\n */\n", + "docComment": "/**\n * Get the type of a coding contract.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Name describing the type of problem posed by the Coding Contract.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5496,9 +4864,8 @@ "text": "): " }, { - "kind": "Reference", - "text": "CodingContractTypes", - "canonicalReference": "bitburner!CodingContractTypes:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -5533,7 +4900,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#getData:member(1)", - "docComment": "/**\n * Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns The specified contract’s data;\n */\n", + "docComment": "/**\n * Get the input data.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns The specified contract’s data;\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5592,7 +4959,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#getDescription:member(1)", - "docComment": "/**\n * Get the full text description for the problem posed by the Coding Contract.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Contract’s text description.\n */\n", + "docComment": "/**\n * Get the description.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Get the full text description for the problem posed by the Coding Contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Contract’s text description.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5651,7 +5018,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!CodingContract#getNumTriesRemaining:member(1)", - "docComment": "/**\n * Get the number of tries remaining on the contract before it self-destructs.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns How many attempts are remaining for the contract;\n */\n", + "docComment": "/**\n * Get the number of attempt remaining.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get the number of tries remaining on the contract before it self-destructs.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns How many attempts are remaining for the contract;\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5710,106 +5077,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!CodingContractTypes:type", - "docComment": "/**\n * All Coding contract types.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type CodingContractTypes =\n " - }, - { - "kind": "Content", - "text": "| \"Find Largest Prime Factor\"\n | \"Subarray with Maximum Sum\"\n | \"Total Ways to Sum\"\n | \"Spiralize Matrix\"\n | \"Array Jumping Game\"\n | \"Merge Overlapping Intervals\"\n | \"Generate IP Addresses\"\n | \"Algorithmic Stock Trader I\"\n | \"Algorithmic Stock Trader II\"\n | \"Algorithmic Stock Trader III\"\n | \"Algorithmic Stock Trader IV\"\n | \"Minimum Path Sum in a Triangle\"\n | \"Unique Paths in a Grid I\"\n | \"Unique Paths in a Grid II\"\n | \"Sanitize Parentheses in Expression\"\n | \"Find All Valid Math Expressions\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "CodingContractTypes", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!CompanyField:type", - "docComment": "/**\n * All company work fields.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type CompanyField =\n " - }, - { - "kind": "Content", - "text": "| \"software\"\n | \"software consultant\"\n | \"it\"\n | \"security engineer\"\n | \"network engineer\"\n | \"business\"\n | \"business consultant\"\n | \"security\"\n | \"agent\"\n | \"employee\"\n | \"part-time employee\"\n | \"waiter\"\n | \"part-time waiter\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "CompanyField", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!CompanyName:type", - "docComment": "/**\n * All companies.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type CompanyName =\n // Sector-12\n " - }, - { - "kind": "Content", - "text": "| \"MegaCorp\"\n | \"BladeIndustries\"\n | \"FourSigma\"\n | \"IcarusMicrosystems\"\n | \"UniversalEnergy\"\n | \"DeltaOne\"\n | \"CIA\"\n | \"NSA\"\n | \"AlphaEnterprises\"\n | \"CarmichaelSecurity\"\n | \"FoodNStuff\"\n | \"JoesGuns\"\n\n // Aevum\n | \"ECorp\"\n | \"BachmanAndAssociates\"\n | \"ClarkeIncorporated\"\n | \"OmniTekIncorporated\"\n | \"FulcrumTechnologies\"\n | \"GalacticCybersystems\"\n | \"AeroCorp\"\n | \"WatchdogSecurity\"\n | \"RhoConstruction\"\n | \"AevumPolice\"\n | \"NetLinkTechnologies\"\n\n // Volhaven\n | \"NWO\"\n | \"HeliosLabs\"\n | \"OmniaCybersystems\"\n | \"LexoCorp\"\n | \"SysCoreSecurities\"\n | \"CompuTek\"\n\n // Chongqing\n | \"KuaiGongInternational\"\n | \"SolarisSpaceSystems\"\n\n // Ishima\n | \"StormTechnologies\"\n | \"NovaMedical\"\n | \"OmegaSoftware\"\n\n // New Tokyo\n | \"DefComm\"\n | \"VitaLife\"\n | \"GlobalPharmaceuticals\"\n | \"NoodleBar\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "CompanyName", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!Crime:type", - "docComment": "/**\n * All crimes.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Crime =\n " - }, - { - "kind": "Content", - "text": "| \"shoplift\"\n | \"rob store\"\n | \"mug\"\n | \"larceny\"\n | \"deal drugs\"\n | \"bond forgery\"\n | \"traffick arms\"\n | \"homicide\"\n | \"grand theft auto\"\n | \"kidnap\"\n | \"assassinate\"\n | \"heist\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "Crime", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!CrimeStats:interface", @@ -6346,60 +5613,10 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!FactionName:type", - "docComment": "/**\n * All factions.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type FactionName =\n " - }, - { - "kind": "Content", - "text": "| \"Illuminati\"\n | \"Daedalus\"\n | \"The Covenant\"\n | \"ECorp\"\n | \"MegaCorp\"\n | \"Bachman & Associates\"\n | \"Blade Industries\"\n | \"NWO\"\n | \"Clarke Incorporated\"\n | \"OmniTek Incorporated\"\n | \"Four Sigma\"\n | \"KuaiGong International\"\n | \"Fulcrum Secret Technologies\"\n | \"BitRunners\"\n | \"The Black Hand\"\n | \"NiteSec\"\n | \"Aevum\"\n | \"Chongqing\"\n | \"Ishima\"\n | \"New Tokyo\"\n | \"Sector-12\"\n | \"Volhaven\"\n | \"Speakers for the Dead\"\n | \"The Dark Army\"\n | \"The Syndicate\"\n | \"Silhouette\"\n | \"Tetrads\"\n | \"Slum Snakes\"\n | \"Netburners\"\n | \"Tian Di Hui\"\n | \"CyberSec\"\n | \"Bladeburners\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FactionName", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!FactionWork:type", - "docComment": "/**\n * All faction work types.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type FactionWork = " - }, - { - "kind": "Content", - "text": "\"hacking\" | \"field\" | \"security\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FactionWork", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!Gang:interface", - "docComment": "/**\n * Gang API\n *\n * @public\n */\n", + "docComment": "/**\n * Gang API\n *\n * @remarks\n *\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this API.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6412,7 +5629,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#ascendMember:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Ascend the specified Gang Member.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param memberName - Name of member to ascend.\n *\n * @returns Object with info about the ascension results.\n */\n", + "docComment": "/**\n * Ascend a gang member.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Ascend the specified Gang Member.\n *\n * @param memberName - Name of member to ascend.\n *\n * @returns Object with info about the ascension results.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6457,7 +5674,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#canRecruitMember:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns boolean indicating whether a member can currently be recruited\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @returns True if a member can currently be recruited, false otherwise.\n */\n", + "docComment": "/**\n * Check if you can recruit a new gang member.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Returns boolean indicating whether a member can currently be recruited\n *\n * @returns True if a member can currently be recruited, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6485,7 +5702,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getBonusTime:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 10x the normal speed.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns Bonus time for the Gang mechanic in seconds.\n */\n", + "docComment": "/**\n * Get bonus time.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 10x the normal speed.\n *\n * @returns Bonus time for the Gang mechanic in milliseconds.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6513,16 +5730,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getChanceToWinClash:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param gangName - Target gang\n *\n * @returns Chance you have to win a clash with the specified gang.\n */\n", + "docComment": "/**\n * Get chance to win clash with other gang.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage\n *\n * @param gangName - Target gang\n *\n * @returns Chance you have to win a clash with the specified gang.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getChanceToWinClash(gangName: " }, { - "kind": "Reference", - "text": "GangName", - "canonicalReference": "bitburner!GangName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -6558,25 +5774,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getEquipmentCost:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments\n */\n", + "docComment": "/**\n * Get cost of equipment.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.\n *\n * @param equipName - Name of equipment.\n *\n * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEquipmentCost(equipName: " }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" + "text": "string" }, { "kind": "Content", @@ -6593,8 +5799,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -6603,7 +5809,7 @@ "parameterName": "equipName", "parameterTypeTokenRange": { "startIndex": 1, - "endIndex": 4 + "endIndex": 2 } } ], @@ -6612,7 +5818,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getEquipmentNames:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @returns Names of all Equpiment/Augmentations.\n */\n", + "docComment": "/**\n * List equipment names.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @returns Names of all Equpiment/Augmentations.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6620,25 +5826,7 @@ }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" - }, - { - "kind": "Content", - "text": ")[]" + "text": "string[]" }, { "kind": "Content", @@ -6648,7 +5836,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 6 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -6658,25 +5846,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getEquipmentStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment stats.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns A dictionary containing the stats of the equipment.\n */\n", + "docComment": "/**\n * Get stats of an equipment.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get the specified equipment stats.\n *\n * @param equipName - Name of equipment.\n *\n * @returns A dictionary containing the stats of the equipment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEquipmentStats(equipName: " }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" + "text": "string" }, { "kind": "Content", @@ -6684,8 +5862,8 @@ }, { "kind": "Reference", - "text": "GangEquipmentStats", - "canonicalReference": "bitburner!GangEquipmentStats:interface" + "text": "stringStats", + "canonicalReference": "bitburner!stringStats:interface" }, { "kind": "Content", @@ -6694,8 +5872,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -6704,7 +5882,7 @@ "parameterName": "equipName", "parameterTypeTokenRange": { "startIndex": 1, - "endIndex": 4 + "endIndex": 2 } } ], @@ -6713,34 +5891,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getEquipmentType:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment type.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Type of the equipment.\n */\n", + "docComment": "/**\n * Get type of an equipment.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get the specified equipment type.\n *\n * @param equipName - Name of equipment.\n *\n * @returns Type of the equipment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getEquipmentType(equipName: " }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" + "text": "string" }, { "kind": "Content", "text": "): " }, { - "kind": "Reference", - "text": "GangEquipmentType", - "canonicalReference": "bitburner!GangEquipmentType:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -6749,8 +5916,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -6759,7 +5926,7 @@ "parameterName": "equipName", "parameterTypeTokenRange": { "startIndex": 1, - "endIndex": 4 + "endIndex": 2 } } ], @@ -6768,7 +5935,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getGangInformation:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get general information about the gang.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @returns Object containing general information about the gang.\n */\n", + "docComment": "/**\n * Get information about your gang.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get general information about the gang.\n *\n * @returns Object containing general information about the gang.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6797,7 +5964,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getMemberInformation:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get stat and equipment-related information about a Gang Member\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param name - Name of member.\n *\n * @returns Object containing stat and equipment-related information about a Gang Member.\n */\n", + "docComment": "/**\n * Get information about a specific gang member.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get stat and equipment-related information about a Gang Member\n *\n * @param name - Name of member.\n *\n * @returns Object containing stat and equipment-related information about a Gang Member.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6842,7 +6009,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getMemberNames:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the names of all Gang members\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @returns Names of all Gang members.\n */\n", + "docComment": "/**\n * List all gang members.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the names of all Gang members\n *\n * @returns Names of all Gang members.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6870,7 +6037,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getOtherGangInformation:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get territory and power information about all gangs.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @returns Object containing territory and power information about all gangs.\n */\n", + "docComment": "/**\n * Get information about the other gangs.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Get territory and power information about all gangs.\n *\n * @returns Object containing territory and power information about all gangs.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6899,20 +6066,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getTaskNames:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all valid tasks that Gang members can be assigned to.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @returns All valid tasks that Gang members can be assigned to.\n */\n", + "docComment": "/**\n * List member task names.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the name of all valid tasks that Gang members can be assigned to.\n *\n * @returns All valid tasks that Gang members can be assigned to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTaskNames(): " }, - { - "kind": "Reference", - "text": "GangTasks", - "canonicalReference": "bitburner!GangTasks:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -6922,7 +6084,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -6932,16 +6094,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#getTaskStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param name - Name of the task.\n *\n * @returns Detailed stats of a task.\n */\n", + "docComment": "/**\n * Get stats of a task.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.\n *\n * @param name - Name of the task.\n *\n * @returns Detailed stats of a task.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getTaskStats(name: " }, { - "kind": "Reference", - "text": "GangTasks", - "canonicalReference": "bitburner!GangTasks:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -6949,8 +6110,8 @@ }, { "kind": "Reference", - "text": "GangTasksStats", - "canonicalReference": "bitburner!GangTasksStats:interface" + "text": "stringStats", + "canonicalReference": "bitburner!stringStats:interface" }, { "kind": "Content", @@ -6978,7 +6139,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#purchaseEquipment:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param memberName - Name of Gang member to purchase the equipment for.\n *\n * @param equipName - Name of Equipment/Augmentation to purchase.\n *\n * @returns True if the equipment was successfully purchased. False otherwise\n */\n", + "docComment": "/**\n * Purchase an equipment for a gang member.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.\n *\n * @param memberName - Name of Gang member to purchase the equipment for.\n *\n * @param equipName - Name of Equipment/Augmentation to purchase.\n *\n * @returns True if the equipment was successfully purchased. False otherwise\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6992,19 +6153,9 @@ "kind": "Content", "text": ", equipName: " }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, { "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" + "text": "string" }, { "kind": "Content", @@ -7021,8 +6172,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -7038,7 +6189,7 @@ "parameterName": "equipName", "parameterTypeTokenRange": { "startIndex": 3, - "endIndex": 6 + "endIndex": 4 } } ], @@ -7047,7 +6198,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#recruitMember:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to recruit a new gang member.\n *\n * Possible reasons for failure: * Cannot currently recruit a new member * There already exists a member with the specified name\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param name - Name of member to recruit.\n *\n * @returns True if the member was successfully recruited, false otherwise.\n */\n", + "docComment": "/**\n * Recruit a new gang member.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Attempt to recruit a new gang member.\n *\n * Possible reasons for failure: * Cannot currently recruit a new member * There already exists a member with the specified name\n *\n * @param name - Name of member to recruit.\n *\n * @returns True if the member was successfully recruited, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7091,7 +6242,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#setMemberTask:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param memberName - Name of Gang member to assign.\n *\n * @param taskName - Task to assign.\n *\n * @returns True if the Gang Member was successfully assigned to the task, false otherwise.\n */\n", + "docComment": "/**\n * Set gang member to task.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).\n *\n * @param memberName - Name of Gang member to assign.\n *\n * @param taskName - Task to assign.\n *\n * @returns True if the Gang Member was successfully assigned to the task, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7106,9 +6257,8 @@ "text": ", taskName: " }, { - "kind": "Reference", - "text": "GangTasks", - "canonicalReference": "bitburner!GangTasks:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -7151,7 +6301,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Gang#setTerritoryWarfare:member(1)", - "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Set whether or not the gang should engage in territory warfare\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @param engage - Whether or not to engage in territory warfare.\n */\n", + "docComment": "/**\n * Enable/Disable territory warfare.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Set whether or not the gang should engage in territory warfare\n *\n * @param engage - Whether or not to engage in territory warfare.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7195,253 +6345,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GangAugmentations:type", - "docComment": "/**\n * All Gang augmentations.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GangAugmentations =\n " - }, - { - "kind": "Content", - "text": "| \"Bionic Arms\"\n | \"Bionic Legs\"\n | \"Bionic Spine\"\n | \"BrachiBlades\"\n | \"Nanofiber Weave\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"BitWire\"\n | \"Neuralstimulator\"\n | \"DataJack\"\n | \"Graphene Bone Lacings\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GangAugmentations", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GangEquipment:type", - "docComment": "/**\n * All Gang equipment.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GangEquipment =\n " - }, - { - "kind": "Content", - "text": "| \"Baseball Bat\"\n | \"Katana\"\n | \"Glock 18C\"\n | \"P90C\"\n | \"Steyr AUG\"\n | \"AK-47\"\n | \"M15A10 Assault Rifle\"\n | \"AWM Sniper Rifle\"\n | \"Bulletproof Vest\"\n | \"Full Body Armor\"\n | \"Liquid Body Armor\"\n | \"Graphene Plating Armor\"\n | \"Ford Flex V20\"\n | \"ATX1070 Superbike\"\n | \"Mercedes-Benz S9001\"\n | \"White Ferrari\"\n | \"NUKE Rootkit\"\n | \"Soulstealer Rootkit\"\n | \"Demon Rootkit\"\n | \"Hmap Node\"\n | \"Jack the Ripper\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GangEquipment", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "bitburner!GangEquipmentStats:interface", - "docComment": "/**\n * Object representing data representing a gang member equipment.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface GangEquipmentStats " - } - ], - "releaseTag": "Public", - "name": "GangEquipmentStats", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#agi:member", - "docComment": "/**\n * Agility multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "agi: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "agi", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#cha:member", - "docComment": "/**\n * Charisma multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "cha: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "cha", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#def:member", - "docComment": "/**\n * Defense multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "def: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "def", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#dex:member", - "docComment": "/**\n * Dexterity multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "dex: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "dex", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#hack:member", - "docComment": "/**\n * Hacking multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hack: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "hack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangEquipmentStats#str:member", - "docComment": "/**\n * Strength multiplier\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "str: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "str", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GangEquipmentType:type", - "docComment": "/**\n * All Gang equipment type.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GangEquipmentType = " - }, - { - "kind": "Content", - "text": "\"Weapon\" | \"Armor\" | \"Vehicle\" | \"Rootkit\" | \"Augmentation\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GangEquipmentType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!GangGenInfo:interface", @@ -7465,9 +6368,8 @@ "text": "faction: " }, { - "kind": "Reference", - "text": "GangName", - "canonicalReference": "bitburner!GangName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -8017,14 +6919,9 @@ "kind": "Content", "text": "augmentations: " }, - { - "kind": "Reference", - "text": "GangAugmentations", - "canonicalReference": "bitburner!GangAugmentations:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -8036,7 +6933,7 @@ "name": "augmentations", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -8282,14 +7179,9 @@ "kind": "Content", "text": "equipment: " }, - { - "kind": "Reference", - "text": "GangEquipment", - "canonicalReference": "bitburner!GangEquipment:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -8301,7 +7193,7 @@ "name": "equipment", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -8470,9 +7362,8 @@ "text": "task: " }, { - "kind": "Reference", - "text": "GangTasks", - "canonicalReference": "bitburner!GangTasks:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -8490,31 +7381,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GangName:type", - "docComment": "/**\n * All factions that can have a gang.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GangName =\n " - }, - { - "kind": "Content", - "text": "| \"Slum Snakes\"\n | \"Tetrads\"\n | \"The Syndicate\"\n | \"The Dark Army\"\n | \"Speakers for the Dead\"\n | \"NiteSec\"\n | \"The Black Hand\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GangName", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "TypeAlias", "canonicalReference": "bitburner!GangOtherInfo:type", @@ -8526,16 +7392,7 @@ }, { "kind": "Content", - "text": "{\n /** Stock Symbol */\n [key in " - }, - { - "kind": "Reference", - "text": "GangName", - "canonicalReference": "bitburner!GangName:type" - }, - { - "kind": "Content", - "text": "]: " + "text": "{\n [key: string]: " }, { "kind": "Reference", @@ -8555,7 +7412,7 @@ "name": "GangOtherInfo", "typeTokenRange": { "startIndex": 1, - "endIndex": 6 + "endIndex": 4 } }, { @@ -8626,583 +7483,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GangTasks:type", - "docComment": "/**\n * All Gang tasks.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GangTasks =\n " - }, - { - "kind": "Content", - "text": "| \"Unassigned\"\n | \"Ransomware\"\n | \"Phishing\"\n | \"Identity Theft\"\n | \"DDoS Attacks\"\n | \"Plant Virus\"\n | \"Fraud & Counterfeiting\"\n | \"Money Laundering\"\n | \"Cyberterrorism\"\n | \"Ethical Hacking\"\n | \"Mug People\"\n | \"Deal Drugs\"\n | \"Strongarm Civilians\"\n | \"Run a Con\"\n | \"Armed Robbery\"\n | \"Traffick Illegal Arms\"\n | \"Threaten & Blackmail\"\n | \"Human Trafficking\"\n | \"Terrorism\"\n | \"Vigilante Justice\"\n | \"Train Combat\"\n | \"Train Hacking\"\n | \"Train Charisma\"\n | \"Territory Warfare\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GangTasks", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "bitburner!GangTasksStats:interface", - "docComment": "/**\n * Object representing data representing a gang member task.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface GangTasksStats " - } - ], - "releaseTag": "Public", - "name": "GangTasksStats", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#agiWeight:member", - "docComment": "/**\n * Agility skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "agiWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "agiWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#baseMoney:member", - "docComment": "/**\n * Base money earned\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "baseMoney: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "baseMoney", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#baseRespect:member", - "docComment": "/**\n * Base respect earned\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "baseRespect: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "baseRespect", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#baseWanted:member", - "docComment": "/**\n * Base wanted earned\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "baseWanted: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "baseWanted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#chaWeight:member", - "docComment": "/**\n * Charisma skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "chaWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "chaWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#defWeight:member", - "docComment": "/**\n * Defense skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "defWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "defWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#desc:member", - "docComment": "/**\n * Task Description\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "desc: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "desc", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#dexWeight:member", - "docComment": "/**\n * Dexterity skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "dexWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "dexWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#difficulty:member", - "docComment": "/**\n * Number representing the difficulty of the task\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "difficulty: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "difficulty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#hackWeight:member", - "docComment": "/**\n * Hacking skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hackWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "hackWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#isCombat:member", - "docComment": "/**\n * Is a task of a combat gang\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "isCombat: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "isCombat", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#isHacking:member", - "docComment": "/**\n * Is a task of a hacking gang\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "isHacking: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "isHacking", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#name:member", - "docComment": "/**\n * Task name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Reference", - "text": "GangTasks", - "canonicalReference": "bitburner!GangTasks:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#strWeight:member", - "docComment": "/**\n * Stength skill impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "strWeight: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "strWeight", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksStats#territory:member", - "docComment": "/**\n * Territory impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "territory: " - }, - { - "kind": "Reference", - "text": "GangTasksTerritory", - "canonicalReference": "bitburner!GangTasksTerritory:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "territory", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "bitburner!GangTasksTerritory:interface", - "docComment": "/**\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface GangTasksTerritory " - } - ], - "releaseTag": "Public", - "name": "GangTasksTerritory", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksTerritory#money:member", - "docComment": "/**\n * Money gain impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "money: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "money", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksTerritory#respect:member", - "docComment": "/**\n * Respect gain impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "respect: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "respect", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "bitburner!GangTasksTerritory#wanted:member", - "docComment": "/**\n * Wanted gain impact on task scaling\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "wanted: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "releaseTag": "Public", - "name": "wanted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!Gym:type", - "docComment": "/**\n * All gyms.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Gym = " - }, - { - "kind": "Content", - "text": "\"Crush Fitness Gym\" | \"Snap Fitness Gym\" | \"Iron Gym\" | \"Powerhouse Gym\" | \"Millenium Fitness Gym\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "Gym", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!GymStat:type", - "docComment": "/**\n * All stats that can be trained at gyms.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type GymStat = " - }, - { - "kind": "Content", - "text": "\"str\" | \"def\" | \"dex\" | \"agi\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "GymStat", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!HackingMultipliers:interface", @@ -9326,7 +7606,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!Hacknet:interface", - "docComment": "/**\n * Hacknet API\n *\n * @public\n */\n", + "docComment": "/**\n * Hacknet API\n *\n * @remarks\n *\n * Not all these functions are immediately available.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9339,7 +7619,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getCacheUpgradeCost:member(1)", - "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the cost of upgrading the cache level of the specified Hacknet Server by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's cache.\n */\n", + "docComment": "/**\n * Calculate the cost of upgrading hacknet node cache.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the cost of upgrading the cache level of the specified Hacknet Server by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's cache.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9398,7 +7678,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getCoreUpgradeCost:member(1)", - "docComment": "/**\n * Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's number of cores.\n */\n", + "docComment": "/**\n * Calculate the cost of upgrading hacknet node cores.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's number of cores.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9457,7 +7737,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getLevelUpgradeCost:member(1)", - "docComment": "/**\n * Returns the cost of upgrading the specified Hacknet Node by n levels.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node.\n */\n", + "docComment": "/**\n * Calculate the cost of upgrading hacknet node levels.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the cost of upgrading the specified Hacknet Node by n levels.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9516,7 +7796,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getNodeStats:member(1)", - "docComment": "/**\n * Returns an object containing a variety of stats about the specified Hacknet Node.\n *\n * Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node\n *\n * @returns Object containing a variety of stats about the specified Hacknet Node.\n */\n", + "docComment": "/**\n * Get the stats of a hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns an object containing a variety of stats about the specified Hacknet Node.\n *\n * Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates.\n *\n * @param index - Index/Identifier of Hacknet Node\n *\n * @returns Object containing a variety of stats about the specified Hacknet Node.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9561,7 +7841,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getPurchaseNodeCost:member(1)", - "docComment": "/**\n * Returns the cost of purchasing a new Hacknet Node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns Cost of purchasing a new Hacknet Node.\n */\n", + "docComment": "/**\n * Get the price of the next hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the cost of purchasing a new Hacknet Node.\n *\n * @returns Cost of purchasing a new Hacknet Node.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9589,7 +7869,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#getRamUpgradeCost:member(1)", - "docComment": "/**\n * Returns the cost of upgrading the RAM of the specified Hacknet Node n times.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's ram.\n */\n", + "docComment": "/**\n * Calculate the cost of upgrading hacknet node RAM.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the cost of upgrading the RAM of the specified Hacknet Node n times.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's ram.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9648,16 +7928,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#hashCost:member(1)", - "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @returns Number of hashes required for the specified upgrade.\n *\n * @example\n * ```ts\n * var upgradeName = \"Sell for Corporation Funds\";\n * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) {\n * hacknet.spendHashes(upgName);\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Get the cost of a hash upgrade.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match.\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @returns Number of hashes required for the specified upgrade.\n *\n * @example\n * ```ts\n * var upgradeName = \"Sell for Corporation Funds\";\n * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) {\n * hacknet.spendHashes(upgName);\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hashCost(upgName: " }, { - "kind": "Reference", - "text": "HashUpgrades", - "canonicalReference": "bitburner!HashUpgrades:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -9693,7 +7972,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#numHashes:member(1)", - "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes you have.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns Number of hashes you have.\n */\n", + "docComment": "/**\n * Get the total number of hashes stored.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes you have.\n *\n * @returns Number of hashes you have.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9721,7 +8000,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#numNodes:member(1)", - "docComment": "/**\n * Returns the number of Hacknet Nodes you own.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns number of hacknet nodes.\n */\n", + "docComment": "/**\n * Get the number of hacknet nodes you own.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Returns the number of Hacknet Nodes you own.\n *\n * @returns number of hacknet nodes.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9749,7 +8028,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#purchaseNode:member(1)", - "docComment": "/**\n * Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named `hacknet-node-4` will have an index of 4).\n *\n * If the player cannot afford to purchase a new Hacknet Node then the function will return -1.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1.\n */\n", + "docComment": "/**\n * Purchase a new hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named `hacknet-node-4` will have an index of 4).\n *\n * If the player cannot afford to purchase a new Hacknet Node then the function will return -1.\n *\n * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9777,16 +8056,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#spendHashes:member(1)", - "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.\n *\n * The name of the upgrade must be an exact match. The `upgTarget` argument is used for upgrades such as `Reduce Minimum Security`, which applies to a specific server. In this case, the `upgTarget` argument must be the hostname of the server.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @param upgTarget - Object to which upgrade applies. Required for certain upgrades.\n *\n * @returns True if the upgrade is successfully purchased, and false otherwise..\n *\n * @example\n * ```ts\n * hacknet.spendHashes(\"Sell for Corporation Funds\");\n * hacknet.spendHashes(\"Increase Maximum Money\", \"foodnstuff\");\n * ```\n *\n */\n", + "docComment": "/**\n * Purchase a hash upgrade.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.\n *\n * The name of the upgrade must be an exact match. The `upgTarget` argument is used for upgrades such as `Reduce Minimum Security`, which applies to a specific server. In this case, the `upgTarget` argument must be the hostname of the server.\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @param upgTarget - Object to which upgrade applies. Required for certain upgrades.\n *\n * @returns True if the upgrade is successfully purchased, and false otherwise..\n *\n * @example\n * ```ts\n * hacknet.spendHashes(\"Sell for Corporation Funds\");\n * hacknet.spendHashes(\"Increase Maximum Money\", \"foodnstuff\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "spendHashes(upgName: " }, { - "kind": "Reference", - "text": "HashUpgrades", - "canonicalReference": "bitburner!HashUpgrades:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -9837,7 +8115,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#upgradeCache:member(1)", - "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Tries to upgrade the specified Hacknet Server’s cache n times.\n *\n * Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "docComment": "/**\n * Upgrade the cache of a hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Tries to upgrade the specified Hacknet Server’s cache n times.\n *\n * Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.\n *\n * Returns false otherwise.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9896,7 +8174,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#upgradeCore:member(1)", - "docComment": "/**\n * Tries to purchase n cores for the specified Hacknet Node.\n *\n * Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "docComment": "/**\n * Upgrade the core of a hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Tries to purchase n cores for the specified Hacknet Node.\n *\n * Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.\n *\n * Returns false otherwise.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9955,7 +8233,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#upgradeLevel:member(1)", - "docComment": "/**\n * Tries to upgrade the level of the specified Hacknet Node by n.\n *\n * Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise.\n */\n", + "docComment": "/**\n * Upgrade the level of a hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Tries to upgrade the level of the specified Hacknet Node by n.\n *\n * Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.\n *\n * Returns false otherwise.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10014,7 +8292,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Hacknet#upgradeRam:member(1)", - "docComment": "/**\n * Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.\n *\n * Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise.\n */\n", + "docComment": "/**\n * Upgrade the RAM of a hacknet node.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.\n *\n * Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.\n *\n * Returns false otherwise.\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10249,31 +8527,6 @@ "endIndex": 3 } }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!HashUpgrades:type", - "docComment": "/**\n * All Hash upgrade names.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type HashUpgrades =\n " - }, - { - "kind": "Content", - "text": "| \"Sell for Money\"\n | \"Sell for Corporation Funds\"\n | \"Reduce Minimum Security\"\n | \"Increase Maximum Money\"\n | \"Improve Studying\"\n | \"Improve Gym Training\"\n | \"Exchange for Corporation Research\"\n | \"Exchange for Bladeburner Rank\"\n | \"Exchange for Bladeburner SP\"\n | \"Generate Coding Contract\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "HashUpgrades", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!NodeStats:interface", @@ -10995,7 +9248,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#fileExists:member(1)", - "docComment": "/**\n * Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'.\n *\n * If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param filename - Filename of file to check.\n *\n * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server.\n *\n * @returns True if specified file exists, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise.\n * fileExists(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise.\n * fileExists(\"ftpcrack.exe\");\n * ```\n *\n */\n", + "docComment": "/**\n * Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'.\n *\n * If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param filename - Filename of file to check.\n *\n * @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.\n *\n * @returns True if specified file exists, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise.\n * fileExists(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise.\n * fileExists(\"ftpcrack.exe\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11182,7 +9435,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getGrowTime:member(1)", - "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11342,7 +9595,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getHackTime:member(1)", - "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11444,7 +9697,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getPortHandle:member(1)", - "docComment": "/**\n * Get a handle to a Netscript Port.\n *\n * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param port - Port number. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n *\n * @see\n *\n * https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports\n */\n", + "docComment": "/**\n * Get a handle to a Netscript Port.\n *\n * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.\n *\n * @remarks\n *\n * RAM cost: 10 GB\n *\n * @param port - Port number. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n *\n * @see\n *\n * https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11883,7 +10136,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getScriptRam:member(1)", - "docComment": "/**\n * Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param script - Filename of script. This is case-sensitive.\n *\n * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server.\n *\n * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist.\n */\n", + "docComment": "/**\n * Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param script - Filename of script. This is case-sensitive.\n *\n * @param host - Host of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server.\n *\n * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11987,7 +10240,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerBaseSecurityLevel:member(1)", - "docComment": "/**\n * Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Base security level of the target server.\n */\n", + "docComment": "/**\n * Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Base security level of the target server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12031,7 +10284,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerGrowth:member(1)", - "docComment": "/**\n * Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function.\n */\n", + "docComment": "/**\n * Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12075,7 +10328,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerMaxMoney:member(1)", - "docComment": "/**\n * Returns the maximum amount of money that can be available on a server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Maximum amount of money available on the server.\n */\n", + "docComment": "/**\n * Returns the maximum amount of money that can be available on a server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Maximum amount of money available on the server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12119,7 +10372,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerMinSecurityLevel:member(1)", - "docComment": "/**\n * Returns the minimum security level of the target server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Minimum security level of the target server.\n */\n", + "docComment": "/**\n * Returns the minimum security level of the target server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Minimum security level of the target server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12163,7 +10416,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerMoneyAvailable:member(1)", - "docComment": "/**\n * Returns the amount of money available on a server. Running this function on the home computer will return the player’s money.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server\n *\n * @returns Amount of money available on the server.\n *\n * @example\n * ```ts\n * getServerMoneyAvailable(\"foodnstuff\");\n * getServerMoneyAvailable(\"home\"); //Returns player's money\n * ```\n *\n */\n", + "docComment": "/**\n * Returns the amount of money available on a server. Running this function on the home computer will return the player’s money.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server\n *\n * @returns Amount of money available on the server.\n *\n * @example\n * ```ts\n * getServerMoneyAvailable(\"foodnstuff\");\n * getServerMoneyAvailable(\"home\"); //Returns player's money\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12207,7 +10460,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerNumPortsRequired:member(1)", - "docComment": "/**\n * Returns the number of open ports required to successfully run NUKE.exe on the specified server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The number of open ports required to successfully run NUKE.exe on the specified server.\n */\n", + "docComment": "/**\n * Returns the number of open ports required to successfully run NUKE.exe on the specified server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns The number of open ports required to successfully run NUKE.exe on the specified server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12251,7 +10504,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerRam:member(1)", - "docComment": "/**\n * Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Array with total and used memory on the specified server.\n *\n * @example\n * ```ts\n * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n", + "docComment": "/**\n * Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Array with total and used memory on the specified server.\n *\n * @example\n * ```ts\n * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12295,7 +10548,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerRequiredHackingLevel:member(1)", - "docComment": "/**\n * Returns the required hacking level of the target server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The required hacking level of the target server.\n */\n", + "docComment": "/**\n * Returns the required hacking level of the target server.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns The required hacking level of the target server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12339,7 +10592,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerSecurityLevel:member(1)", - "docComment": "/**\n * Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Security level of the target server.\n */\n", + "docComment": "/**\n * Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100).\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns Security level of the target server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12411,7 +10664,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getWeakenTime:member(1)", - "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12485,7 +10738,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#grow:member(1)", - "docComment": "/**\n * Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When `grow` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.\n *\n * Like hack, `grow` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004.\n *\n * @remarks\n *\n * RAM cost: 0.15 GB\n *\n * @param host - Hostname of the target server to grow.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The number by which the money on the server was multiplied for the growth.\n *\n * @example\n * ```ts\n * grow(\"foodnstuff\");\n * grow(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to grow\n * ```\n *\n */\n", + "docComment": "/**\n * Spoof money in a servers bank account, increasing the amount available.\n *\n * @remarks\n *\n * 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 a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.\n *\n * Like hack, `grow` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004.\n *\n * @param host - Hostname of the target server to grow.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The number by which the money on the server was multiplied for the growth.\n *\n * @example\n * ```ts\n * grow(\"foodnstuff\");\n * grow(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to grow\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12653,7 +10906,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#hack:member(1)", - "docComment": "/**\n * Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level.\n *\n * A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game.\n *\n * A successful `hack()` on a server will raise that server’s security level by 0.002.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Hostname of the target server to hack.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount of money stolen if the hack is successful, and zero otherwise.\n *\n * @example\n * ```ts\n * hack(\"foodnstuff\");\n * hack(\"10.1.2.3\");\n * hack(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to hack\n * ```\n *\n */\n", + "docComment": "/**\n * Steal a servers money.\n *\n * @remarks\n *\n * 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. In order to hack a server you must first gain root access to that server and also have the required hacking level.\n *\n * A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game.\n *\n * A successful `hack()` on a server will raise that server’s security level by 0.002.\n *\n * @param host - Hostname of the target server to hack.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount of money stolen if the hack is successful, and zero otherwise.\n *\n * @example\n * ```ts\n * hack(\"foodnstuff\");\n * hack(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to hack\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12806,7 +11059,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#hackAnalyzeThreads:member(1)", - "docComment": "/**\n * This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param host - Hostname of the target server to analyze.\n *\n * @param hackAmount - Amount of money you want to hack from the server.\n *\n * @returns The number of threads needed to hack the server for hackAmount money.\n *\n * @example\n * ```ts\n * //For example, let’s say the foodnstuff server has $10m and you run:\n * hackAnalyzeThreads(\"foodnstuff\", 1e6);\n * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.\n * ```\n *\n */\n", + "docComment": "/**\n * Predict the effect of hack.\n *\n * @remarks\n *\n * 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.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @param host - Hostname of the target server to analyze.\n *\n * @param hackAmount - Amount of money you want to hack from the server.\n *\n * @returns The number of threads needed to hack the server for hackAmount money.\n *\n * @example\n * ```ts\n * //For example, let’s say the foodnstuff server has $10m and you run:\n * hackAnalyzeThreads(\"foodnstuff\", 1e6);\n * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12909,7 +11162,7 @@ { "kind": "PropertySignature", "canonicalReference": "bitburner!NS#hacknet:member", - "docComment": "/**\n * Namespace for hacknet related functions.\n *\n * @remarks\n *\n * Not all functions in the Hacknet Node API are immediately available.\n *\n * Note that none of these functions will write to the script’s logs.\n *\n * If you want to see what your script is doing you will have to print to the logs yourself.\n *\n * 4 GB\n */\n", + "docComment": "/**\n * Namespace for hacknet related functions.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n */\n", "excerptTokens": [ { "kind": "Content", @@ -12936,7 +11189,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#hasRootAccess:member(1)", - "docComment": "/**\n * Returns a boolean indicating whether or not the player has root access to the specified target server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host or IP of the target server\n *\n * @returns True if player has root access to the specified target server, and false otherwise.\n *\n * @example\n * ```ts\n * if (hasRootAccess(\"foodnstuff\") == false) {\n * nuke(\"foodnstuff\");\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Returns a boolean indicating whether or not the player has root access to the specified target server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Host of the target server\n *\n * @returns True if player has root access to the specified target server, and false otherwise.\n *\n * @example\n * ```ts\n * if (hasRootAccess(\"foodnstuff\") == false) {\n * nuke(\"foodnstuff\");\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -13068,7 +11321,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#isRunning:member(1)", - "docComment": "/**\n * Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @param args - Arguments to specify/identify which scripts to search for.\n *\n * @returns True if specified script is running on the target server, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise:\n * isRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise:\n * isRunning(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:\n * isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", + "docComment": "/**\n * Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host of target server.\n *\n * @param args - Arguments to specify/identify which scripts to search for.\n *\n * @returns True if specified script is running on the target server, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise:\n * isRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise:\n * isRunning(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:\n * isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -13304,7 +11557,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#ls:member(1)", - "docComment": "/**\n * Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * @param host - Host or IP of the target server.\n *\n * @param grep - A substring to search for in the filename.\n *\n * @returns Array with the filenames of all files on the specified server.\n */\n", + "docComment": "/**\n * Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * @param host - Host of the target server.\n *\n * @param grep - A substring to search for in the filename.\n *\n * @returns Array with the filenames of all files on the specified server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -13604,7 +11857,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#ps:member(1)", - "docComment": "/**\n * Returns an array with general information about all scripts running on the specified target server.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default.\n *\n * @returns Array with general information about all scripts running on the specified target server.\n *\n * @example\n * ```ts\n * //(using NetscriptJS (Netscript 2.0))\n * export async function main(ns) {\n * const ps = ns.ps(\"home\");\n * for (let i = 0; i < ps.length; ++i) {\n * ns.tprint(ps[i].filename + ' ' + ps[i].threads);\n * ns.tprint(ps[i].args);\n * }\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Returns an array with general information about all scripts running on the specified target server.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * @param host - Host address of the target server. If not specified, it will be the current server’s IP by default.\n *\n * @returns Array with general information about all scripts running on the specified target server.\n *\n * @example\n * ```ts\n * //(using NetscriptJS (Netscript 2.0))\n * export async function main(ns) {\n * const ps = ns.ps(\"home\");\n * for (let i = 0; i < ps.length; ++i) {\n * ns.tprint(ps[i].filename + ' ' + ps[i].threads);\n * ns.tprint(ps[i].args);\n * }\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -13677,7 +11930,7 @@ }, { "kind": "Content", - "text": "string | \"\"" + "text": "string" }, { "kind": "Content", @@ -13801,7 +12054,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#rm:member(1)", - "docComment": "/**\n * Removes the specified file from the current server. This function works for every file type except message (.msg) files.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param name - Filename of file to remove. Must include the extension.\n *\n * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server.\n *\n * @returns True if it successfully deletes the file, and false otherwise.\n */\n", + "docComment": "/**\n * Removes the specified file from the current server. This function works for every file type except message (.msg) files.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param name - Filename of file to remove. Must include the extension.\n *\n * @param host - Host Address of the server on which to delete the file. Optional. Defaults to current server.\n *\n * @returns True if it successfully deletes the file, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -13993,7 +12246,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#scp:member(1)", - "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * RAM cost: 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```ts\n * //Copies hack-template.script from the current server to foodnstuff:\n * scp(\"hack-template.script\", \"foodnstuff\");\n * ```\n *\n */\n", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * RAM cost: 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param destination - Host of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```ts\n * //Copies hack-template.script from the current server to foodnstuff:\n * scp(\"hack-template.script\", \"foodnstuff\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14001,16 +12254,7 @@ }, { "kind": "Content", - "text": "string | " - }, - { - "kind": "Reference", - "text": "ReadonlyArray", - "canonicalReference": "!ReadonlyArray:interface" - }, - { - "kind": "Content", - "text": "" + "text": "string[]" }, { "kind": "Content", @@ -14035,8 +12279,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -14045,14 +12289,14 @@ "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 1, - "endIndex": 4 + "endIndex": 2 } }, { "parameterName": "destination", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 } } ], @@ -14061,7 +12305,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#scp:member(2)", - "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * RAM cost: 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```ts\n * //Copies foo.lit from the helios server to the home computer:\n * scp(\"foo.lit\", \"helios\", \"home\");\n * ```\n *\n * @example\n * ```ts\n * //Tries to copy three files from rothman-uni to home computer:\n * files = [\"foo1.lit\", \"foo2.script\", \"foo3.script\"];\n * scp(files, \"rothman-uni\", \"home\");\n * ```\n *\n */\n", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * RAM cost: 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.\n *\n * @param destination - Host of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```ts\n * //Copies foo.lit from the helios server to the home computer:\n * scp(\"foo.lit\", \"helios\", \"home\");\n * ```\n *\n * @example\n * ```ts\n * //Tries to copy three files from rothman-uni to home computer:\n * files = [\"foo1.lit\", \"foo2.script\", \"foo3.script\"];\n * scp(files, \"rothman-uni\", \"home\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14069,16 +12313,7 @@ }, { "kind": "Content", - "text": "string | " - }, - { - "kind": "Reference", - "text": "ReadonlyArray", - "canonicalReference": "!ReadonlyArray:interface" - }, - { - "kind": "Content", - "text": "" + "text": "string[]" }, { "kind": "Content", @@ -14111,8 +12346,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, @@ -14121,21 +12356,21 @@ "parameterName": "files", "parameterTypeTokenRange": { "startIndex": 1, - "endIndex": 4 + "endIndex": 2 } }, { "parameterName": "source", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "destination", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 5, + "endIndex": 6 } } ], @@ -14144,7 +12379,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#scriptKill:member(1)", - "docComment": "/**\n * Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param script - Filename of script to kill. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns true if one or more scripts were successfully killed, and false if none were.\n */\n", + "docComment": "/**\n * Kills all scripts with the specified filename on the target server specified by hostname, regardless of arguments.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param script - Filename of script to kill. This is case-sensitive.\n *\n * @param host - Host of target server.\n *\n * @returns true if one or more scripts were successfully killed, and false if none were.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14203,7 +12438,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#scriptRunning:member(1)", - "docComment": "/**\n * Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.\n *\n * This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if the specified script is running, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise:\n * scriptRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:\n * scriptRunning(\"foo.script\", getHostname());\n * ```\n *\n */\n", + "docComment": "/**\n * Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.\n *\n * This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host of target server.\n *\n * @returns True if the specified script is running, and false otherwise.\n *\n * @example\n * ```ts\n * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise:\n * scriptRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```ts\n * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:\n * scriptRunning(\"foo.script\", getHostname());\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14262,7 +12497,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#serverExists:member(1)", - "docComment": "/**\n * Returns a boolean denoting whether or not the specified server exists.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if specified server exists, and false otherwise.\n */\n", + "docComment": "/**\n * Returns a boolean denoting whether or not the specified server exists.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @param host - Host of target server.\n *\n * @returns True if specified server exists, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14721,7 +12956,7 @@ }, { "kind": "Content", - "text": "string | string[] | number" + "text": "string[] | number" }, { "kind": "Content", @@ -14823,7 +13058,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#weaken:member(1)", - "docComment": "/**\n * Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.\n *\n * Like hack and grow, `weaken` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command.\n *\n * @remarks\n *\n * RAM cost: 0.15 GB\n *\n * @param host - Hostname of the target server to weaken.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads.\n *\n * @example\n * ```ts\n * weaken(\"foodnstuff\");\n * weaken(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to weaken\n * ```\n *\n */\n", + "docComment": "/**\n * Reduce a server security level.\n *\n * @remarks\n *\n * 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 command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.\n *\n * Like hack and grow, `weaken` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command.\n *\n * @param host - Hostname of the target server to weaken.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads.\n *\n * @example\n * ```ts\n * weaken(\"foodnstuff\");\n * weaken(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to weaken\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14888,7 +13123,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#weakenAnalyze:member(1)", - "docComment": "/**\n * Returns the security decrease that would occur if a weaken with this many threads happened.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @param cores - Optional. The number of cores of the server that would run weaken.\n *\n * @returns The security decrease.\n */\n", + "docComment": "/**\n * Predict the effect of weaken.\n *\n * @remarks\n *\n * RAM cost: 1 GB Returns the security decrease that would occur if a weaken with this many threads happened.\n *\n * @param threads - Amount of threads that will be used.\n *\n * @param cores - Optional. The number of cores of the server that would run weaken.\n *\n * @returns The security decrease.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15043,7 +13278,7 @@ }, { "kind": "Content", - "text": "string | string[] | number" + "text": "string[] | number" }, { "kind": "Content", @@ -15106,56 +13341,6 @@ } ] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!OrderPosition:type", - "docComment": "/**\n * All possible stock market order positions.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type OrderPosition = " - }, - { - "kind": "Content", - "text": "\"long\" | \"short\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "OrderPosition", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!OrderType:type", - "docComment": "/**\n * All possible stock market order type.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type OrderType = " - }, - { - "kind": "Content", - "text": "\"limitbuy\" | \"limitsell\" | \"stopbuy\" | \"stopsell\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "OrderType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!PlayerSkills:interface", @@ -15365,7 +13550,7 @@ }, { "kind": "Content", - "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20" + "text": "number" }, { "kind": "Content", @@ -15473,31 +13658,6 @@ ], "extendsTokenRanges": [] }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!Programs:type", - "docComment": "/**\n * All programs.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Programs =\n " - }, - { - "kind": "Content", - "text": "| \"autolink.exe\"\n | \"brutessh.exe\"\n | \"deepscanv1.exe\"\n | \"deepscanv2.exe\"\n | \"ftpcrack.exe\"\n | \"httpworm.exe\"\n | \"relaysmtp.exe\"\n | \"serverprofiler.exe\"\n | \"sqlinject.exe\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "Programs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, { "kind": "Interface", "canonicalReference": "bitburner!Server:interface", @@ -15855,7 +14015,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!Singularity:interface", - "docComment": "/**\n * Singularity API\n *\n * @public\n */\n", + "docComment": "/**\n * Singularity API\n *\n * @remarks\n *\n * This API requires Source-File 4 level 1 / 2 / 3 to use.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15868,25 +14028,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#applyToCompany:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.\n *\n * This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of company to apply to.\n *\n * @param field - Field to which you want to apply.\n *\n * @returns True if the player successfully get a job/promotion, and false otherwise.\n */\n", + "docComment": "/**\n * Apply for a job at a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.\n *\n * This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.\n *\n * @param companyName - Name of company to apply to.\n *\n * @param field - Field to which you want to apply.\n *\n * @returns True if the player successfully get a job/promotion, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "applyToCompany(companyName: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", field: " }, { - "kind": "Reference", - "text": "CompanyField", - "canonicalReference": "bitburner!CompanyField:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -15929,20 +14087,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#checkFactionInvitations:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array with the name of all Factions you currently have oustanding invitations from.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns Array with the name of all Factions you currently have oustanding invitations from.\n */\n", + "docComment": "/**\n * List all current faction invitations.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * Returns an array with the name of all Factions you currently have oustanding invitations from.\n *\n * @returns Array with the name of all Factions you currently have oustanding invitations from.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkFactionInvitations(): " }, - { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -15952,7 +14105,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -15962,16 +14115,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#commitCrime:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n", + "docComment": "/**\n * Commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "commitCrime(crime: " }, { - "kind": "Reference", - "text": "Crime", - "canonicalReference": "bitburner!Crime:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16007,16 +14159,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#createProgram:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns true if you successfully start working on the specified program, and false otherwise.\n *\n * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: * BruteSSH.exe: 50 * FTPCrack.exe: 100 * relaySMTP.exe: 250 * HTTPWorm.exe: 500 * SQLInject.exe: 750 * DeepscanV1.exe: 75 * DeepscanV2.exe: 400 * ServerProfiler.exe: 75 * AutoLink.exe: 25\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param program - Name of program to create.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```ts\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", + "docComment": "/**\n * Create a program.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns true if you successfully start working on the specified program, and false otherwise.\n *\n * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: * BruteSSH.exe: 50 * FTPCrack.exe: 100 * relaySMTP.exe: 250 * HTTPWorm.exe: 500 * SQLInject.exe: 750 * DeepscanV1.exe: 75 * DeepscanV2.exe: 400 * ServerProfiler.exe: 75 * AutoLink.exe: 25\n *\n * @param program - Name of program to create.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```ts\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createProgram(program: " }, { - "kind": "Reference", - "text": "Programs", - "canonicalReference": "bitburner!Programs:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16052,16 +14203,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#donateToFaction:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction to donate to.\n *\n * @param amount - Amount of money to donate.\n *\n * @returns True if the money was donated, and false otherwise.\n */\n", + "docComment": "/**\n * Donate to a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.\n *\n * @param faction - Name of faction to donate to.\n *\n * @param amount - Amount of money to donate.\n *\n * @returns True if the money was donated, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "donateToFaction(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16111,17 +14261,16 @@ }, { "kind": "MethodSignature", - "canonicalReference": "bitburner!Singularity#getAugmentationCost:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.\n *\n * If an invalid Augmentation name is passed in for the augName argument, this function will return the array [-1, -1].\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with first element as a reputation requirement and second element as the money cost.\n */\n", + "canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)", + "docComment": "/**\n * Get the pre-requisite of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getAugmentationCost(augName: " + "text": "getAugmentationPrereq(augName: " }, { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16129,7 +14278,7 @@ }, { "kind": "Content", - "text": "[number, number]" + "text": "string[]" }, { "kind": "Content", @@ -16152,84 +14301,28 @@ } } ], - "name": "getAugmentationCost" - }, - { - "kind": "MethodSignature", - "canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAugmentationPrereq(augName: " - }, - { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "augName", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], "name": "getAugmentationPrereq" }, { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationsFromFaction:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction.\n *\n * @returns Array containing the names of all Augmentations.\n */\n", + "docComment": "/**\n * Get a list of augmentation available from a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.\n *\n * @param faction - Name of faction.\n *\n * @returns Array containing the names of all Augmentations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAugmentationsFromFaction(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": "): " }, - { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -16239,7 +14332,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, - "endIndex": 5 + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -16257,16 +14350,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns augmentation stats.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param name - Name of Augmentation. CASE-SENSITIVE.\n *\n * @returns Augmentation stats.\n */\n", + "docComment": "/**\n * Get the stats of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns augmentation stats.\n *\n * @param name - Name of Augmentation. CASE-SENSITIVE.\n *\n * @returns Augmentation stats.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAugmentationStats(name: " }, { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16300,48 +14392,18 @@ ], "name": "getAugmentationStats" }, - { - "kind": "MethodSignature", - "canonicalReference": "bitburner!Singularity#getCharacterInformation:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with various information about your character.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns Object with various information about your character.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getCharacterInformation(): " - }, - { - "kind": "Reference", - "text": "CharacterInfo", - "canonicalReference": "bitburner!CharacterInfo:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getCharacterInformation" - }, { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyFavor:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you have at the specified company.\n */\n", + "docComment": "/**\n * Get company favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you have at the specified company.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCompanyFavor(companyName: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16377,16 +14439,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyFavorGain:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.\n */\n", + "docComment": "/**\n * Get company favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCompanyFavorGain(companyName: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16422,16 +14483,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyRep:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of reputation you have at the specified company.\n */\n", + "docComment": "/**\n * Get company reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of reputation you have at the specified company.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCompanyRep(companyName: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16467,16 +14527,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCrimeChance:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6).\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime.\n *\n * @returns Chance of success at commiting the specified crime as a decimal.\n */\n", + "docComment": "/**\n * Get chance to successfully commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns your chance of success at commiting the specified crime.\n *\n * @param crime - Name of crime.\n *\n * @returns Chance of success at commiting the specified crime.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCrimeChance(crime: " }, { - "kind": "Reference", - "text": "Crime", - "canonicalReference": "bitburner!Crime:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16512,16 +14571,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCrimeStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the stats of the crime.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime. Not case-sensitive\n *\n * @returns The stats of the crime.\n */\n", + "docComment": "/**\n * Get stats related to a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns the stats of the crime.\n *\n * @param crime - Name of crime. Not case-sensitive\n *\n * @returns The stats of the crime.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getCrimeStats(crime: " }, { - "kind": "Reference", - "text": "Crime", - "canonicalReference": "bitburner!Crime:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16558,16 +14616,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionFavor:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you have for the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you have for the specified faction.\n */\n", + "docComment": "/**\n * Get faction favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of favor you have for the specified faction.\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you have for the specified faction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFactionFavor(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16603,16 +14660,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionFavorGain:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n */\n", + "docComment": "/**\n * Get faction favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFactionFavorGain(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16648,16 +14704,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionRep:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of reputation you have for the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @returns Amount of reputation you have for the specified faction.\n */\n", + "docComment": "/**\n * Get faction reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of reputation you have for the specified faction.\n *\n * @param faction - Name of faction to work for.\n *\n * @returns Amount of reputation you have for the specified faction.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getFactionRep(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16693,7 +14748,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getOwnedAugmentations:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array containing the names (as strings) of all Augmentations you have.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.\n *\n * @returns Array containing the names (as strings) of all Augmentations you have.\n */\n", + "docComment": "/**\n * Get a list of owned augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns an array containing the names (as strings) of all Augmentations you have.\n *\n * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.\n *\n * @returns Array containing the names (as strings) of all Augmentations you have.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16707,14 +14762,9 @@ "kind": "Content", "text": "): " }, - { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -16724,7 +14774,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, - "endIndex": 5 + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -16742,7 +14792,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getOwnedSourceFiles:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array of source files\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @returns Array containing an object with number and level of the source file.\n */\n", + "docComment": "/**\n * Get a list of acquired Source-Files.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns an array of source files\n *\n * @returns Array containing an object with number and level of the source file.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16772,39 +14822,10 @@ "parameters": [], "name": "getOwnedSourceFiles" }, - { - "kind": "MethodSignature", - "canonicalReference": "bitburner!Singularity#getStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with the Player’s stats.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns Object with the Player’s stats.\n *\n * @example\n * ```ts\n * res = getStats();\n * print('My charisma level is: ' + res.charisma);\n * ```\n *\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getStats(): " - }, - { - "kind": "Reference", - "text": "PlayerSkills", - "canonicalReference": "bitburner!PlayerSkills:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getStats" - }, { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getUpgradeHomeRamCost:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the cost of upgrading the player’s home computer RAM.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns Cost of upgrading the player’s home computer RAM.\n */\n", + "docComment": "/**\n * Get the price of upgrading home RAM.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB\n *\n * Singularity - Level 2\n *\n * Returns the cost of upgrading the player’s home computer RAM.\n *\n * @returns Cost of upgrading the player’s home computer RAM.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16832,25 +14853,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#gymWorkout:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.\n *\n * @param stat - The stat you want to train.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "docComment": "/**\n * Workout at the gym.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train\n *\n * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.\n *\n * @param stat - The stat you want to train.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gymWorkout(gymName: " }, { - "kind": "Reference", - "text": "Gym", - "canonicalReference": "bitburner!Gym:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", stat: " }, { - "kind": "Reference", - "text": "GymStat", - "canonicalReference": "bitburner!GymStat:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -16893,7 +14912,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#installAugmentations:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically install your Augmentations, resetting the game as usual.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.\n */\n", + "docComment": "/**\n * Install your purchased augmentations.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will automatically install your Augmentations, resetting the game as usual.\n *\n * @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.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16937,7 +14956,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#isBusy:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if the player is currently performing an ‘action’, false otherwise.\n */\n", + "docComment": "/**\n * Check if the player is busy.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * Singularity - Level 1\n *\n * Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.\n *\n * @returns True if the player is currently performing an ‘action’, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16965,16 +14984,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#joinFaction:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically accept an invitation from a faction and join it.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to join.\n *\n * @returns True if player joined the faction, and false otherwise.\n */\n", + "docComment": "/**\n * Join a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically accept an invitation from a faction and join it.\n *\n * @param faction - Name of faction to join.\n *\n * @returns True if player joined the faction, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "joinFaction(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17010,25 +15028,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseAugmentation:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will try to purchase the specified Augmentation through the given Faction.\n *\n * This function will return true if the Augmentation is successfully purchased, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction to purchase Augmentation from.\n *\n * @param augmnet - Name of Augmentation to purchase.\n *\n * @returns True if the Augmentation is successfully purchased, and false otherwise.\n */\n", + "docComment": "/**\n * Purchase an augmentation\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will try to purchase the specified Augmentation through the given Faction.\n *\n * This function will return true if the Augmentation is successfully purchased, and false otherwise.\n *\n * @param faction - Name of faction to purchase Augmentation from.\n *\n * @param augmentation - Name of Augmentation to purchase.\n *\n * @returns True if the Augmentation is successfully purchased, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "purchaseAugmentation(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", - "text": ", augmnet: " + "text": ", augmentation: " }, { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17059,7 +15075,7 @@ } }, { - "parameterName": "augmnet", + "parameterName": "augmentation", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 @@ -17071,16 +15087,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseProgram:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param programName - Name of program to purchase.\n *\n * @returns True if the specified program is purchased, and false otherwise.\n *\n * @example\n * ```ts\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n", + "docComment": "/**\n * Purchase a program from the dark web.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.\n *\n * @param programName - Name of program to purchase.\n *\n * @returns True if the specified program is purchased, and false otherwise.\n *\n * @example\n * ```ts\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "purchaseProgram(programName: " }, { - "kind": "Reference", - "text": "Programs", - "canonicalReference": "bitburner!Programs:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17116,7 +15131,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseTor:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "docComment": "/**\n * Purchase the TOR router.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.\n *\n * @returns True if actions is successful, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17144,7 +15159,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#softReset:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\n *\n * @remarks\n *\n * Singularity - Level 3\n */\n", + "docComment": "/**\n * Soft reset the game.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17172,7 +15187,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#stopAction:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.\n *\n * The actions that can be stopped with this function are:\n *\n * * Studying at a university * Working for a company/faction * Creating a program * Committing a Crime\n *\n * This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if the player’s action was ended, false if the player was not performing an action.\n */\n", + "docComment": "/**\n * Stop the current action.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 1\n *\n * This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.\n *\n * The actions that can be stopped with this function are:\n *\n * * Studying at a university * Working for a company/faction * Creating a program * Committing a Crime\n *\n * This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called.\n *\n * @returns True if the player’s action was ended, false if the player was not performing an action.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17200,16 +15215,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#travelToCity:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param city - City to travel to.\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "docComment": "/**\n * Travel to another city.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency.\n *\n * @param city - City to travel to.\n *\n * @returns True if actions is successful, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "travelToCity(city: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17245,25 +15259,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#universityCourse:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param universityName - Name of university. You must be in the correct city for whatever university you specify.\n *\n * @param courseName - Name of course.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "docComment": "/**\n * Take university class.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.\n *\n * @param universityName - Name of university. You must be in the correct city for whatever university you specify.\n *\n * @param courseName - Name of course.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "universityCourse(universityName: " }, { - "kind": "Reference", - "text": "University", - "canonicalReference": "bitburner!University:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", courseName: " }, { - "kind": "Reference", - "text": "UniversityCourse", - "canonicalReference": "bitburner!UniversityCourse:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17306,7 +15318,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#upgradeHomeRam:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.\n */\n", + "docComment": "/**\n * Upgrade home computer RAM.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.\n *\n * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17334,16 +15346,15 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#workForCompany:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if the player starts working, and false otherwise.\n *\n * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n", + "docComment": "/**\n * Work for a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if the player starts working, and false otherwise.\n *\n * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action.\n *\n * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workForCompany(companyName?: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17379,25 +15390,23 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#workForFaction:member(1)", - "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if you successfully start working for the specified faction, and false otherwise.\n *\n * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @param workType - Type of work to perform for the faction.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n", + "docComment": "/**\n * Work for a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if you successfully start working for the specified faction, and false otherwise.\n *\n * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action.\n *\n * @param faction - Name of faction to work for.\n *\n * @param workType - Type of work to perform for the faction.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workForFaction(faction: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", workType: " }, { - "kind": "Reference", - "text": "FactionWork", - "canonicalReference": "bitburner!FactionWork:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17443,7 +15452,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!Sleeve:interface", - "docComment": "/**\n * Sleeve API\n *\n * @public\n */\n", + "docComment": "/**\n * Sleeve API\n *\n * @remarks\n *\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17456,7 +15465,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getInformation:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a struct containing tons of information about this sleeve\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve information.\n *\n * @returns Object containing tons of information about this sleeve.\n */\n", + "docComment": "/**\n * Get information about a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a struct containing tons of information about this sleeve\n *\n * @param sleeveNumber - Index of the sleeve to retrieve information.\n *\n * @returns Object containing tons of information about this sleeve.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17501,7 +15510,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getNumSleeves:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the number of duplicate sleeves the player has.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @returns number of duplicate sleeves the player has.\n */\n", + "docComment": "/**\n * Get the number of sleeves you own.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return the number of duplicate sleeves the player has.\n *\n * @returns number of duplicate sleeves the player has.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17529,7 +15538,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getSleeveAugmentations:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentation names that this sleeve has installed.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve augmentations from.\n *\n * @returns List of augmentation names that this sleeve has installed.\n */\n", + "docComment": "/**\n * Get augmentations installed on a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a list of augmentation names that this sleeve has installed.\n *\n * @param sleeveNumber - Index of the sleeve to retrieve augmentations from.\n *\n * @returns List of augmentation names that this sleeve has installed.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17543,14 +15552,9 @@ "kind": "Content", "text": "): " }, - { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -17560,7 +15564,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, - "endIndex": 5 + "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, @@ -17578,7 +15582,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getSleevePurchasableAugs:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentations that the player can buy for this sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from.\n *\n * @returns List of augmentations that the player can buy for this sleeve.\n */\n", + "docComment": "/**\n * List purchasable augs for a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a list of augmentations that the player can buy for this sleeve.\n *\n * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from.\n *\n * @returns List of augmentations that the player can buy for this sleeve.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17627,7 +15631,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getSleeveStats:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a structure containing the stats of the sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to get stats of.\n *\n * @returns Object containing the stats of the sleeve.\n */\n", + "docComment": "/**\n * Get the stats of a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a structure containing the stats of the sleeve.\n *\n * @param sleeveNumber - Index of the sleeve to get stats of.\n *\n * @returns Object containing the stats of the sleeve.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17672,7 +15676,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#getTask:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve task from.\n *\n * @returns Object containing information the current task that the sleeve is performing.\n */\n", + "docComment": "/**\n * Get task of a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything.\n *\n * @param sleeveNumber - Index of the sleeve to retrieve task from.\n *\n * @returns Object containing information the current task that the sleeve is performing.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17717,7 +15721,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#purchaseSleeveAug:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return true if the aug was purchased and installed on the sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to buy an aug for.\n *\n * @param augName - Name of the aug to buy. Must be an exact match.\n *\n * @returns True if the aug was purchased and installed on the sleeve, false otherwise.\n */\n", + "docComment": "/**\n * Purchase an aug for a sleeve.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return true if the aug was purchased and installed on the sleeve.\n *\n * @param sleeveNumber - Index of the sleeve to buy an aug for.\n *\n * @param augName - Name of the aug to buy. Must be an exact match.\n *\n * @returns True if the aug was purchased and installed on the sleeve, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17732,9 +15736,8 @@ "text": ", augName: " }, { - "kind": "Reference", - "text": "AugmentName", - "canonicalReference": "bitburner!AugmentName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17777,7 +15780,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToCommitCrime:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start commiting crime.\n *\n * @param name - Name of the crime. Must be an exact match.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to commit crime.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * Returns false if an invalid action is specified.\n *\n * @param sleeveNumber - Index of the sleeve to start commiting crime.\n *\n * @param name - Name of the crime. Must be an exact match.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17792,9 +15795,8 @@ "text": ", name: " }, { - "kind": "Reference", - "text": "Crime", - "canonicalReference": "bitburner!Crime:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17837,7 +15839,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToCompanyWork:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this company.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the company.\n *\n * @param companyName - Name of the company to work for.\n *\n * @returns True if the sleeve started working on this company, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to work for a company.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not the sleeve started working or this company.\n *\n * @param sleeveNumber - Index of the sleeve to work for the company.\n *\n * @param companyName - Name of the company to work for.\n *\n * @returns True if the sleeve started working on this company, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17852,9 +15854,8 @@ "text": ", companyName: " }, { - "kind": "Reference", - "text": "CompanyName", - "canonicalReference": "bitburner!CompanyName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17897,7 +15898,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToFactionWork:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this faction.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the faction.\n *\n * @param factionName - Name of the faction to work for.\n *\n * @param factionWorkType - Name of the action to perform for this faction.\n *\n * @returns True if the sleeve started working on this faction, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to work for a faction.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not the sleeve started working or this faction.\n *\n * @param sleeveNumber - Index of the sleeve to work for the faction.\n *\n * @param factionName - Name of the faction to work for.\n *\n * @param factionWorkType - Name of the action to perform for this faction.\n *\n * @returns True if the sleeve started working on this faction, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17912,18 +15913,16 @@ "text": ", factionName: " }, { - "kind": "Reference", - "text": "FactionName", - "canonicalReference": "bitburner!FactionName:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", factionWorkType: " }, { - "kind": "Reference", - "text": "FactionWork", - "canonicalReference": "bitburner!FactionWork:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -17973,7 +15972,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToGymWorkout:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working out.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to workout at the gym.\n *\n * @param gymName - Name of the gym.\n *\n * @param stat - Name of the stat to train.\n *\n * @returns True if the sleeve started working out, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to workout at the gym.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not the sleeve started working out.\n *\n * @param sleeveNumber - Index of the sleeve to workout at the gym.\n *\n * @param gymName - Name of the gym.\n *\n * @param stat - Name of the stat to train.\n *\n * @returns True if the sleeve started working out, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17988,18 +15987,16 @@ "text": ", gymName: " }, { - "kind": "Reference", - "text": "Gym", - "canonicalReference": "bitburner!Gym:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", stat: " }, { - "kind": "Reference", - "text": "GymStat", - "canonicalReference": "bitburner!GymStat:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -18049,7 +16046,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToShockRecovery:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start recovery.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to shock recovery.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @param sleeveNumber - Index of the sleeve to start recovery.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18093,7 +16090,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToSynchronize:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start synchronizing.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to synchronize.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @param sleeveNumber - Index of the sleeve to start synchronizing.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18137,7 +16134,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#setToUniversityCourse:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start taking class.\n *\n * @param university - Name of the university to attend.\n *\n * @param className - Name of the class to follow.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "docComment": "/**\n * Set a sleeve to take a class at a university.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @param sleeveNumber - Index of the sleeve to start taking class.\n *\n * @param university - Name of the university to attend.\n *\n * @param className - Name of the class to follow.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18152,18 +16149,16 @@ "text": ", university: " }, { - "kind": "Reference", - "text": "University", - "canonicalReference": "bitburner!University:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", className: " }, { - "kind": "Reference", - "text": "UniversityCourse", - "canonicalReference": "bitburner!UniversityCourse:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -18213,7 +16208,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Sleeve#travel:member(1)", - "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve reached destination.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to travel.\n *\n * @param cityName - Name of the destination city.\n *\n * @returns True if the sleeve reached destination, false otherwise.\n */\n", + "docComment": "/**\n * Make a sleeve travel to another city.\n *\n * @remarks\n *\n * RAM cost: 4 GB\n *\n * Return a boolean indicating whether or not the sleeve reached destination.\n *\n * @param sleeveNumber - Index of the sleeve to travel.\n *\n * @param cityName - Name of the destination city.\n *\n * @returns True if the sleeve reached destination, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18228,9 +16223,8 @@ "text": ", cityName: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -18296,9 +16290,8 @@ "text": "city: " }, { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -18455,14 +16448,9 @@ "kind": "Content", "text": "jobTitle: " }, - { - "kind": "Reference", - "text": "CompanyField", - "canonicalReference": "bitburner!CompanyField:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -18474,7 +16462,7 @@ "name": "jobTitle", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -18857,14 +16845,9 @@ "kind": "Content", "text": "crime: " }, - { - "kind": "Reference", - "text": "Crime", - "canonicalReference": "bitburner!Crime:type" - }, { "kind": "Content", - "text": " | \"\"" + "text": "string" }, { "kind": "Content", @@ -18876,7 +16859,7 @@ "name": "crime", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -18888,14 +16871,9 @@ "kind": "Content", "text": "factionWorkType: " }, - { - "kind": "Reference", - "text": "FactionWork", - "canonicalReference": "bitburner!FactionWork:type" - }, { "kind": "Content", - "text": " | \"\"" + "text": "string" }, { "kind": "Content", @@ -18907,7 +16885,7 @@ "name": "factionWorkType", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -18919,14 +16897,9 @@ "kind": "Content", "text": "gymStatType: " }, - { - "kind": "Reference", - "text": "GymStat", - "canonicalReference": "bitburner!GymStat:type" - }, { "kind": "Content", - "text": " | \"\"" + "text": "string" }, { "kind": "Content", @@ -18938,7 +16911,7 @@ "name": "gymStatType", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -18950,14 +16923,9 @@ "kind": "Content", "text": "location: " }, - { - "kind": "Reference", - "text": "City", - "canonicalReference": "bitburner!City:type" - }, { "kind": "Content", - "text": " | \"\"" + "text": "string" }, { "kind": "Content", @@ -18969,7 +16937,7 @@ "name": "location", "propertyTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 } }, { @@ -19249,7 +17217,7 @@ }, { "kind": "Content", - "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12" + "text": "number" }, { "kind": "Content", @@ -19278,16 +17246,7 @@ }, { "kind": "Content", - "text": "{\n /** Stock Symbol */\n [key in " - }, - { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" - }, - { - "kind": "Content", - "text": "]?: " + "text": "{\n [key: string]: " }, { "kind": "Reference", @@ -19307,7 +17266,7 @@ "name": "StockOrder", "typeTokenRange": { "startIndex": 1, - "endIndex": 6 + "endIndex": 4 } }, { @@ -19334,7 +17293,7 @@ }, { "kind": "Content", - "text": "\"S\" | \"L\"" + "text": "string" }, { "kind": "Content", @@ -19412,7 +17371,7 @@ }, { "kind": "Content", - "text": "\"Limit Buy Order\" | \"Limit Sell Order\" | \"Stop Buy Order\" | \"Stop Buy Order\"" + "text": "string" }, { "kind": "Content", @@ -19431,29 +17390,661 @@ "extendsTokenRanges": [] }, { - "kind": "TypeAlias", - "canonicalReference": "bitburner!StockSymbol:type", - "docComment": "/**\n * All possible stock market symbols.\n *\n * @public\n */\n", + "kind": "Interface", + "canonicalReference": "bitburner!stringStats:interface", + "docComment": "/**\n * Object representing data representing a gang member task.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "type StockSymbol =\n " - }, - { - "kind": "Content", - "text": "| \"ECP\"\n | \"MGCP\"\n | \"BLD\"\n | \"CLRK\"\n | \"OMTK\"\n | \"FSIG\"\n | \"KGI\"\n | \"FLCM\"\n | \"STM\"\n | \"DCOMM\"\n | \"HLS\"\n | \"VITA\"\n | \"ICRS\"\n | \"UNV\"\n | \"AERO\"\n | \"OMN\"\n | \"SLRS\"\n | \"GPH\"\n | \"NVMD\"\n | \"WDS\"\n | \"LXO\"\n | \"RHOC\"\n | \"APHE\"\n | \"SYSC\"\n | \"CTK\"\n | \"NTLK\"\n | \"OMGA\"\n | \"FNS\"\n | \"SGC\"\n | \"JGN\"\n | \"CTYS\"\n | \"MDYN\"\n | \"TITN\"" - }, - { - "kind": "Content", - "text": ";" + "text": "interface stringStats " } ], "releaseTag": "Public", - "name": "StockSymbol", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } + "name": "stringStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#agi:member", + "docComment": "/**\n * Agility multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agi: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agi", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#agiWeight:member", + "docComment": "/**\n * Agility skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agiWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agiWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#baseMoney:member", + "docComment": "/**\n * Base money earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#baseRespect:member", + "docComment": "/**\n * Base respect earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseRespect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseRespect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#baseWanted:member", + "docComment": "/**\n * Base wanted earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseWanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseWanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#cha:member", + "docComment": "/**\n * Charisma multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cha: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#chaWeight:member", + "docComment": "/**\n * Charisma skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "chaWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "chaWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#def:member", + "docComment": "/**\n * Defense multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "def: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "def", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#defWeight:member", + "docComment": "/**\n * Defense skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#desc:member", + "docComment": "/**\n * Task Description\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "desc: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "desc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#dex:member", + "docComment": "/**\n * Dexterity multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dex: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#dexWeight:member", + "docComment": "/**\n * Dexterity skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#difficulty:member", + "docComment": "/**\n * Number representing the difficulty of the task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "difficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "difficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#hack:member", + "docComment": "/**\n * Hacking multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#hackWeight:member", + "docComment": "/**\n * Hacking skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#isCombat:member", + "docComment": "/**\n * Is a task of a combat gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isCombat: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isCombat", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#isHacking:member", + "docComment": "/**\n * Is a task of a hacking gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isHacking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isHacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#name:member", + "docComment": "/**\n * Task name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#str:member", + "docComment": "/**\n * Strength multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "str: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "str", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#strWeight:member", + "docComment": "/**\n * Stength skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringStats#territory:member", + "docComment": "/**\n * Territory impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Reference", + "text": "stringTerritory", + "canonicalReference": "bitburner!stringTerritory:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!stringTerritory:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface stringTerritory " + } + ], + "releaseTag": "Public", + "name": "stringTerritory", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringTerritory#money:member", + "docComment": "/**\n * Money gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringTerritory#respect:member", + "docComment": "/**\n * Respect gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!stringTerritory#wanted:member", + "docComment": "/**\n * Wanted gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] }, { "kind": "Interface", @@ -19478,9 +18069,8 @@ "text": "buy(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19538,9 +18128,8 @@ "text": "cancelOrder(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19563,18 +18152,16 @@ "text": ", type: " }, { - "kind": "Reference", - "text": "OrderType", - "canonicalReference": "bitburner!OrderType:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", pos: " }, { - "kind": "Reference", - "text": "OrderPosition", - "canonicalReference": "bitburner!OrderPosition:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19645,9 +18232,8 @@ "text": "getAskPrice(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19690,9 +18276,8 @@ "text": "getBidPrice(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19735,9 +18320,8 @@ "text": "getForecast(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19780,9 +18364,8 @@ "text": "getMaxShares(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19818,7 +18401,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!TIX#getOrders:member(1)", - "docComment": "/**\n * Returns your order book for the stock market.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure:\n * ```ts\n * {\n * StockSymbol1: [ // Array of orders for this stock\n * {\n * shares: Order quantity\n * price: Order price\n * type: Order type\n * position: Either \"L\" or \"S\" for Long or Short position\n * },\n * {\n * ...\n * },\n * ...\n * ],\n * StockSymbol2: [ // Array of orders for this stock\n * ...\n * ],\n * ...\n * }\n * ```\n *\n * The “Order type” property can have one of the following four values: \"Limit Buy Order\", \"Limit Sell Order\", \"Stop Buy Order\", \"Stop Sell Order\". Note that the order book will only contain information for stocks that you actually have orders in.\n *\n * @returns Object containing information for all the Limit and Stop Orders you have in the stock market.\n *\n * @example\n * ```ts\n * \"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property.\"\n * {\n * ECP: [\n * {\n * shares: 5,\n * price: 100,000\n * type: \"Stop Buy Order\",\n * position: \"S\",\n * },\n * {\n * shares: 25,\n * price: 125,000\n * type: \"Limit Sell Order\",\n * position: \"L\",\n * },\n * ],\n * SYSC: [\n * {\n * shares: 100,\n * price: 10,000\n * type: \"Limit Buy Order\",\n * position: \"L\",\n * },\n * ],\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Returns your order book for the stock market.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure:\n * ```ts\n * {\n * string1: [ // Array of orders for this stock\n * {\n * shares: Order quantity\n * price: Order price\n * type: Order type\n * position: Either \"L\" or \"S\" for Long or Short position\n * },\n * {\n * ...\n * },\n * ...\n * ],\n * string2: [ // Array of orders for this stock\n * ...\n * ],\n * ...\n * }\n * ```\n *\n * The “Order type” property can have one of the following four values: \"Limit Buy Order\", \"Limit Sell Order\", \"Stop Buy Order\", \"Stop Sell Order\". Note that the order book will only contain information for stocks that you actually have orders in.\n *\n * @returns Object containing information for all the Limit and Stop Orders you have in the stock market.\n *\n * @example\n * ```ts\n * \"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property.\"\n * {\n * ECP: [\n * {\n * shares: 5,\n * price: 100,000\n * type: \"Stop Buy Order\",\n * position: \"S\",\n * },\n * {\n * shares: 25,\n * price: 125,000\n * type: \"Limit Sell Order\",\n * position: \"L\",\n * },\n * ],\n * SYSC: [\n * {\n * shares: 100,\n * price: 10,000\n * type: \"Limit Buy Order\",\n * position: \"L\",\n * },\n * ],\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -19854,9 +18437,8 @@ "text": "getPosition(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19899,9 +18481,8 @@ "text": "getPrice(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19944,9 +18525,8 @@ "text": "getPurchaseCost(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -19961,9 +18541,8 @@ "text": ", posType: " }, { - "kind": "Reference", - "text": "OrderPosition", - "canonicalReference": "bitburner!OrderPosition:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20020,9 +18599,8 @@ "text": "getSaleGain(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20037,9 +18615,8 @@ "text": ", posType: " }, { - "kind": "Reference", - "text": "OrderPosition", - "canonicalReference": "bitburner!OrderPosition:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20095,14 +18672,9 @@ "kind": "Content", "text": "getSymbols(): " }, - { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" - }, { "kind": "Content", - "text": "[]" + "text": "string[]" }, { "kind": "Content", @@ -20112,7 +18684,7 @@ "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, - "endIndex": 3 + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, @@ -20129,9 +18701,8 @@ "text": "getVolatility(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20174,9 +18745,8 @@ "text": "placeOrder(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20199,18 +18769,16 @@ "text": ", type: " }, { - "kind": "Reference", - "text": "OrderType", - "canonicalReference": "bitburner!OrderType:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", "text": ", pos: " }, { - "kind": "Reference", - "text": "OrderPosition", - "canonicalReference": "bitburner!OrderPosition:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20337,9 +18905,8 @@ "text": "sell(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20397,9 +18964,8 @@ "text": "sellShort(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20457,9 +19023,8 @@ "text": "short(sym: " }, { - "kind": "Reference", - "text": "StockSymbol", - "canonicalReference": "bitburner!StockSymbol:type" + "kind": "Content", + "text": "string" }, { "kind": "Content", @@ -20509,56 +19074,6 @@ } ], "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!University:type", - "docComment": "/**\n * All universities.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type University = " - }, - { - "kind": "Content", - "text": "\"Summit University\" | \"Rothman University\" | \"ZB Institute Of Technology\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "University", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "bitburner!UniversityCourse:type", - "docComment": "/**\n * All university courses.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type UniversityCourse =\n " - }, - { - "kind": "Content", - "text": "| \"Study Computer Science\"\n | \"Data Strucures\"\n | \"Networks\"\n | \"Algorithms\"\n | \"Management\"\n | \"Leadership\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "UniversityCourse", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } } ] } diff --git a/markdown/bitburner.augmentname.md b/markdown/bitburner.augmentname.md deleted file mode 100644 index 3abf087d3..000000000 --- a/markdown/bitburner.augmentname.md +++ /dev/null @@ -1,118 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentName](./bitburner.augmentname.md) - -## AugmentName type - -All augmentation names. - -Signature: - -```typescript -type AugmentName = - | "Augmented Targeting I" - | "Augmented Targeting II" - | "Augmented Targeting III" - | "Synthetic Heart" - | "Synfibril Muscle" - | "Combat Rib I" - | "Combat Rib II" - | "Combat Rib III" - | "Nanofiber Weave" - | "NEMEAN Subdermal Weave" - | "Wired Reflexes" - | "Graphene Bone Lacings" - | "Bionic Spine" - | "Graphene Bionic Spine Upgrade" - | "Bionic Legs" - | "Graphene Bionic Legs Upgrade" - | "Speech Processor Implant" - | "TITN-41 Gene-Modification Injection" - | "Enhanced Social Interaction Implant" - | "BitWire" - | "Artificial Bio-neural Network Implant" - | "Artificial Synaptic Potentiation" - | "Enhanced Myelin Sheathing" - | "Synaptic Enhancement Implant" - | "Neural-Retention Enhancement" - | "DataJack" - | "Embedded Netburner Module" - | "Embedded Netburner Module Core Implant" - | "Embedded Netburner Module Core V2 Upgrade" - | "Embedded Netburner Module Core V3 Upgrade" - | "Embedded Netburner Module Analyze Engine" - | "Embedded Netburner Module Direct Memory Access Upgrade" - | "Neuralstimulator" - | "Neural Accelerator" - | "Cranial Signal Processors - Gen I" - | "Cranial Signal Processors - Gen II" - | "Cranial Signal Processors - Gen III" - | "Cranial Signal Processors - Gen IV" - | "Cranial Signal Processors - Gen V" - | "Neuronal Densification" - | "Nuoptimal Nootropic Injector Implant" - | "Speech Enhancement" - | "FocusWire" - | "PC Direct-Neural Interface" - | "PC Direct-Neural Interface Optimization Submodule" - | "PC Direct-Neural Interface NeuroNet Injector" - | "ADR-V1 Pheromone Gene" - | "ADR-V2 Pheromone Gene" - | "The Shadow's Simulacrum" - | "Hacknet Node CPU Architecture Neural-Upload" - | "Hacknet Node Cache Architecture Neural-Upload" - | "Hacknet Node NIC Architecture Neural-Upload" - | "Hacknet Node Kernel Direct-Neural Interface" - | "Hacknet Node Core Direct-Neural Interface" - | "NeuroFlux Governor" - | "Neurotrainer I" - | "Neurotrainer II" - | "Neurotrainer III" - | "HyperSight Corneal Implant" - | "LuminCloaking-V1 Skin Implant" - | "LuminCloaking-V2 Skin Implant" - | "HemoRecirculator" - | "SmartSonar Implant" - | "Power Recirculation Core" - | "QLink" - | "The Red Pill" - | "SPTN-97 Gene Modification" - | "ECorp HVMind Implant" - | "CordiARC Fusion Reactor" - | "SmartJaw" - | "Neotra" - | "Xanipher" - | "nextSENS Gene Modification" - | "OmniTek InfoLoad" - | "Photosynthetic Cells" - | "BitRunners Neurolink" - | "The Black Hand" - | "CRTX42-AA Gene Modification" - | "Neuregen Gene Modification" - | "CashRoot Starter Kit" - | "NutriGen Implant" - | "INFRARET Enhancement" - | "DermaForce Particle Barrier" - | "Graphene BranchiBlades Upgrade" - | "Graphene Bionic Arms Upgrade" - | "BrachiBlades" - | "Bionic Arms" - | "Social Negotiation Assistant (S.N.A)" - | "EsperTech Bladeburner Eyewear" - | "EMS-4 Recombination" - | "ORION-MKIV Shoulder" - | "Hyperion Plasma Cannon V1" - | "Hyperion Plasma Cannon V2" - | "GOLEM Serum" - | "Vangelis Virus" - | "Vangelis Virus 3.0" - | "I.N.T.E.R.L.I.N.K.E.D" - | "Blade's Runners" - | "BLADE-51b Tesla Armor" - | "BLADE-51b Tesla Armor: Power Cells Upgrade" - | "BLADE-51b Tesla Armor: Energy Shielding Upgrade" - | "BLADE-51b Tesla Armor: Unibeam Upgrade" - | "BLADE-51b Tesla Armor: Omnibeam Upgrade" - | "BLADE-51b Tesla Armor: IPU Upgrade" - | "The Blade's Simulacrum"; -``` diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md index 080de50da..c78d64415 100644 --- a/markdown/bitburner.augmentpair.md +++ b/markdown/bitburner.augmentpair.md @@ -17,5 +17,5 @@ interface AugmentPair | Property | Type | Description | | --- | --- | --- | | [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost | -| [name](./bitburner.augmentpair.name.md) | [AugmentName](./bitburner.augmentname.md) | augmentation name | +| [name](./bitburner.augmentpair.name.md) | string | augmentation name | diff --git a/markdown/bitburner.augmentpair.name.md b/markdown/bitburner.augmentpair.name.md index 60513dff8..095ac60b7 100644 --- a/markdown/bitburner.augmentpair.name.md +++ b/markdown/bitburner.augmentpair.name.md @@ -9,5 +9,5 @@ augmentation name Signature: ```typescript -name: AugmentName; +name: string; ``` diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md index 710dd5823..85993e578 100644 --- a/markdown/bitburner.bladeburner.getactionautolevel.md +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -4,27 +4,20 @@ ## Bladeburner.getActionAutolevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Return a boolean indicating whether or not this action is currently set to autolevel. - -Returns false if an invalid action is specified. +Get wether an action is set to autolevel. Signature: ```typescript -getActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; +getActionAutolevel(type: string, name: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -36,3 +29,7 @@ True if the action is set to autolevel, and false otherwise. 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. + diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index 5db081b3e..500261c12 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -4,27 +4,20 @@ ## Bladeburner.getActionCountRemaining() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the remaining count of the specified action. - -Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. +Get action count remaining. Signature: ```typescript -getActionCountRemaining( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getActionCountRemaining(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -36,3 +29,7 @@ Remaining count of the specified action. RAM cost: 4 GB +Returns the remaining count of the specified action. + +Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. + diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md index ab41c5a65..07b232f72 100644 --- a/markdown/bitburner.bladeburner.getactioncurrentlevel.md +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -4,27 +4,20 @@ ## Bladeburner.getActionCurrentLevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the current level of this action. - -Returns -1 if an invalid action is specified. +Get the current level of an action. Signature: ```typescript -getActionCurrentLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getActionCurrentLevel(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -36,3 +29,7 @@ Current level of the specified action. RAM cost: 4 GB +Returns the current level of this action. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md index 5da2723e8..be0d992ed 100644 --- a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -4,25 +4,20 @@ ## Bladeburner.getActionEstimatedSuccessChance() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). +Get estimate success chance of an action. Signature: ```typescript -getActionEstimatedSuccessChance( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getActionEstimatedSuccessChance(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -34,3 +29,5 @@ Estimated success chance for the specified action. 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). + diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md index ff4d0da2c..5b4629ea5 100644 --- a/markdown/bitburner.bladeburner.getactionmaxlevel.md +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -4,27 +4,20 @@ ## Bladeburner.getActionMaxLevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the maximum level for this action. - -Returns -1 if an invalid action is specified. +Get the maximum level of an action. Signature: ```typescript -getActionMaxLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getActionMaxLevel(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -36,3 +29,7 @@ Maximum level of the specified action. RAM cost: 4 GB +Returns the maximum level for this action. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md index 844f338be..96bcc0f11 100644 --- a/markdown/bitburner.bladeburner.getactionrepgain.md +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -4,26 +4,20 @@ ## Bladeburner.getActionRepGain() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. +Get the reputation gain of an action. Signature: ```typescript -getActionRepGain( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): number; +getActionRepGain(type: string, name: string, level: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | | level | number | Optional action level at which to calculate the gain | Returns: @@ -36,3 +30,5 @@ Average Bladeburner reputation gain for successfully completing the specified ac 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. + diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md index de51e5e1b..7bb64b187 100644 --- a/markdown/bitburner.bladeburner.getactiontime.md +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -4,33 +4,30 @@ ## Bladeburner.getActionTime() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the number of seconds it takes to complete the specified action +Get the time to complete an action. Signature: ```typescript -getActionTime( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getActionTime(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: number -Number of seconds it takes to complete the specified action. +Number of milliseconds it takes to complete the specified action. ## Remarks RAM cost: 4 GB +Returns the number of seconds it takes to complete the specified action + diff --git a/markdown/bitburner.bladeburner.getblackopnames.md b/markdown/bitburner.bladeburner.getblackopnames.md index 0d4a5cc33..abd073e1a 100644 --- a/markdown/bitburner.bladeburner.getblackopnames.md +++ b/markdown/bitburner.bladeburner.getblackopnames.md @@ -4,18 +4,16 @@ ## Bladeburner.getBlackOpNames() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array of strings containing the names of all Bladeburner Black Ops. +List all black ops. Signature: ```typescript -getBlackOpNames(): BladeburnerBlackOps[]; +getBlackOpNames(): string[]; ``` Returns: -[BladeburnerBlackOps](./bitburner.bladeburnerblackops.md)\[\] +string\[\] Array of strings containing the names of all Bladeburner Black Ops. @@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner Black Ops. RAM cost: 0.4 GB +Returns an array of strings containing the names of all Bladeburner Black Ops. + diff --git a/markdown/bitburner.bladeburner.getblackoprank.md b/markdown/bitburner.bladeburner.getblackoprank.md index 1a5477fb3..cd05f50db 100644 --- a/markdown/bitburner.bladeburner.getblackoprank.md +++ b/markdown/bitburner.bladeburner.getblackoprank.md @@ -4,23 +4,19 @@ ## Bladeburner.getBlackOpRank() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the rank required to complete this BlackOp. - -Returns -1 if an invalid action is specified. +Get black op required rank. Signature: ```typescript -getBlackOpRank(name: BladeburnerBlackOps): number; +getBlackOpRank(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of BlackOp. Must be an exact match. | +| name | string | Name of BlackOp. Must be an exact match. | Returns: @@ -32,3 +28,7 @@ Rank required to complete this BlackOp. RAM cost: 2 GB +Returns the rank required to complete this BlackOp. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getbonustime.md b/markdown/bitburner.bladeburner.getbonustime.md index 71cf925b3..77eb07099 100644 --- a/markdown/bitburner.bladeburner.getbonustime.md +++ b/markdown/bitburner.bladeburner.getbonustime.md @@ -4,13 +4,7 @@ ## Bladeburner.getBonusTime() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. - -“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. - -“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. +Get bladeburner bonus time. Signature: @@ -21,9 +15,15 @@ getBonusTime(): number; number -Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. +Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. ## Remarks RAM cost: 0 GB +Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. + diff --git a/markdown/bitburner.bladeburner.getcity.md b/markdown/bitburner.bladeburner.getcity.md index b23cafab3..a97627638 100644 --- a/markdown/bitburner.bladeburner.getcity.md +++ b/markdown/bitburner.bladeburner.getcity.md @@ -4,18 +4,16 @@ ## Bladeburner.getCity() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the city that the player is currently in (for Bladeburner). +Get current city. Signature: ```typescript -getCity(): City; +getCity(): string; ``` Returns: -[City](./bitburner.city.md) +string City that the player is currently in (for Bladeburner). @@ -23,3 +21,5 @@ City that the player is currently in (for Bladeburner). RAM cost: 4 GB +Returns the city that the player is currently in (for Bladeburner). + diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md index b2f1d7052..20b997e38 100644 --- a/markdown/bitburner.bladeburner.getcitychaos.md +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -4,21 +4,19 @@ ## Bladeburner.getCityChaos() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the chaos in the specified city, or -1 if an invalid city was specified. +Get chaos of a city. Signature: ```typescript -getCityChaos(name: City): number; +getCityChaos(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [City](./bitburner.city.md) | | +| name | string | | Returns: @@ -30,3 +28,5 @@ Chaos in the specified city. RAM cost: 4 GB +Returns the chaos in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md index 3ddb6045d..3d9057fb2 100644 --- a/markdown/bitburner.bladeburner.getcitycommunities.md +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -4,21 +4,19 @@ ## Bladeburner.getCityCommunities() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. +Get number of communities in a city. Signature: ```typescript -getCityCommunities(name: City): number; +getCityCommunities(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [City](./bitburner.city.md) | | +| name | string | | Returns: @@ -30,3 +28,5 @@ Number of Synthoids communities in the specified city. RAM cost: 4 GB +Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md index 78b9ad5d3..7e9c07e68 100644 --- a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -4,21 +4,19 @@ ## Bladeburner.getCityEstimatedPopulation() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. +Get estimated population in city. Signature: ```typescript -getCityEstimatedPopulation(name: City): number; +getCityEstimatedPopulation(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [City](./bitburner.city.md) | | +| name | string | | Returns: @@ -30,3 +28,5 @@ Estimated number of Synthoids in the specified city. RAM cost: 4 GB +Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcontractnames.md b/markdown/bitburner.bladeburner.getcontractnames.md index e7b9440cd..9ea54b621 100644 --- a/markdown/bitburner.bladeburner.getcontractnames.md +++ b/markdown/bitburner.bladeburner.getcontractnames.md @@ -4,18 +4,16 @@ ## Bladeburner.getContractNames() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array of strings containing the names of all Bladeburner contracts. +List all contracts. Signature: ```typescript -getContractNames(): BladeburnerContracts[]; +getContractNames(): string[]; ``` Returns: -[BladeburnerContracts](./bitburner.bladeburnercontracts.md)\[\] +string\[\] Array of strings containing the names of all Bladeburner contracts. @@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner contracts. RAM cost: 0.4 GB +Returns an array of strings containing the names of all Bladeburner contracts. + diff --git a/markdown/bitburner.bladeburner.getcurrentaction.md b/markdown/bitburner.bladeburner.getcurrentaction.md index b751095f0..a2a1b87d0 100644 --- a/markdown/bitburner.bladeburner.getcurrentaction.md +++ b/markdown/bitburner.bladeburner.getcurrentaction.md @@ -4,9 +4,7 @@ ## Bladeburner.getCurrentAction() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. +Get current action. Signature: @@ -23,3 +21,5 @@ Object that represents the player’s current Bladeburner action. 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”. + diff --git a/markdown/bitburner.bladeburner.getgeneralactionnames.md b/markdown/bitburner.bladeburner.getgeneralactionnames.md index 802336725..2786ddcc4 100644 --- a/markdown/bitburner.bladeburner.getgeneralactionnames.md +++ b/markdown/bitburner.bladeburner.getgeneralactionnames.md @@ -4,18 +4,16 @@ ## Bladeburner.getGeneralActionNames() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array of strings containing the names of all general Bladeburner actions. +List all general actions. Signature: ```typescript -getGeneralActionNames(): BladeburnerGenActions[]; +getGeneralActionNames(): string[]; ``` Returns: -[BladeburnerGenActions](./bitburner.bladeburnergenactions.md)\[\] +string\[\] Array of strings containing the names of all general Bladeburner actions. @@ -23,3 +21,5 @@ Array of strings containing the names of all general Bladeburner actions. RAM cost: 0.4 GB +Returns an array of strings containing the names of all general Bladeburner actions. + diff --git a/markdown/bitburner.bladeburner.getoperationnames.md b/markdown/bitburner.bladeburner.getoperationnames.md index 94ef593b0..659f4718e 100644 --- a/markdown/bitburner.bladeburner.getoperationnames.md +++ b/markdown/bitburner.bladeburner.getoperationnames.md @@ -4,18 +4,16 @@ ## Bladeburner.getOperationNames() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array of strings containing the names of all Bladeburner operations. +List all operations. Signature: ```typescript -getOperationNames(): BladeburnerOperations[]; +getOperationNames(): string[]; ``` Returns: -[BladeburnerOperations](./bitburner.bladeburneroperations.md)\[\] +string\[\] Array of strings containing the names of all Bladeburner operations. @@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner operations. RAM cost: 0.4 GB +Returns an array of strings containing the names of all Bladeburner operations. + diff --git a/markdown/bitburner.bladeburner.getrank.md b/markdown/bitburner.bladeburner.getrank.md index f779e0415..a3160bdb4 100644 --- a/markdown/bitburner.bladeburner.getrank.md +++ b/markdown/bitburner.bladeburner.getrank.md @@ -4,9 +4,7 @@ ## Bladeburner.getRank() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the player’s Bladeburner Rank. +Get player bladeburner rank. Signature: @@ -23,3 +21,5 @@ Player’s Bladeburner Rank. RAM cost: 4 GB +Returns the player’s Bladeburner Rank. + diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md index 52c6ffc5f..2c797f083 100644 --- a/markdown/bitburner.bladeburner.getskilllevel.md +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -4,23 +4,19 @@ ## Bladeburner.getSkillLevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -This function returns your level in the specified skill. - -The function returns -1 if an invalid skill name is passed in. +Get skill level. Signature: ```typescript -getSkillLevel(name: BladeburnerSkills): number; +getSkillLevel(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | +| name | string | | Returns: @@ -32,3 +28,7 @@ Level in the specified skill. 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. + diff --git a/markdown/bitburner.bladeburner.getskillnames.md b/markdown/bitburner.bladeburner.getskillnames.md index 02bef3e28..14df6f225 100644 --- a/markdown/bitburner.bladeburner.getskillnames.md +++ b/markdown/bitburner.bladeburner.getskillnames.md @@ -4,18 +4,16 @@ ## Bladeburner.getSkillNames() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array of strings containing the names of all general Bladeburner skills. +List all skills. Signature: ```typescript -getSkillNames(): BladeburnerSkills[]; +getSkillNames(): string[]; ``` Returns: -[BladeburnerSkills](./bitburner.bladeburnerskills.md)\[\] +string\[\] Array of strings containing the names of all general Bladeburner skills. @@ -23,3 +21,5 @@ Array of strings containing the names of all general Bladeburner skills. RAM cost: 0.4 GB +Returns an array of strings containing the names of all general Bladeburner skills. + diff --git a/markdown/bitburner.bladeburner.getskillpoints.md b/markdown/bitburner.bladeburner.getskillpoints.md index 4bffec461..466f82b6c 100644 --- a/markdown/bitburner.bladeburner.getskillpoints.md +++ b/markdown/bitburner.bladeburner.getskillpoints.md @@ -4,9 +4,7 @@ ## Bladeburner.getSkillPoints() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the number of Bladeburner skill points you have. +Get bladeburner skill points. Signature: @@ -23,3 +21,5 @@ Number of Bladeburner skill points you have. RAM cost: 4 GB +Returns the number of Bladeburner skill points you have. + diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md index c0e59bad0..7795be541 100644 --- a/markdown/bitburner.bladeburner.getskillupgradecost.md +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -4,23 +4,19 @@ ## Bladeburner.getSkillUpgradeCost() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -This function returns the number of skill points needed to upgrade the specified skill. - -The function returns -1 if an invalid skill name is passed in. +Get cost to upgrade skill. Signature: ```typescript -getSkillUpgradeCost(name: BladeburnerSkills): number; +getSkillUpgradeCost(name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | +| name | string | | Returns: @@ -32,3 +28,7 @@ Number of skill points needed to upgrade the specified skill. RAM cost: 4 GB +This function returns the number of skill points needed to upgrade the specified skill. + +The function returns -1 if an invalid skill name is passed in. + diff --git a/markdown/bitburner.bladeburner.getstamina.md b/markdown/bitburner.bladeburner.getstamina.md index 025317cc9..a6a493363 100644 --- a/markdown/bitburner.bladeburner.getstamina.md +++ b/markdown/bitburner.bladeburner.getstamina.md @@ -4,9 +4,7 @@ ## Bladeburner.getStamina() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns an array with two elements: \* \[Current stamina, Max stamina\] +Get bladeburner stamina. Signature: @@ -21,7 +19,7 @@ Array containing current stamina and max stamina. ## Remarks -RAM cost: 4 GB +RAM cost: 4 GB Returns an array with two elements: \* \[Current stamina, Max stamina\] ## Example diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md index aa2ad7f20..aa3d2da47 100644 --- a/markdown/bitburner.bladeburner.getteamsize.md +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -4,27 +4,20 @@ ## Bladeburner.getTeamSize() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Returns the number of Bladeburner team members you have assigned to the specified action. - -Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. +Get team size. Signature: ```typescript -getTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; +getTeamSize(type: string, name: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | Returns: @@ -36,3 +29,7 @@ Number of Bladeburner team members that were assigned to the specified action. 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. + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md index 72bce6eb5..649f72e32 100644 --- a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md +++ b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md @@ -4,13 +4,7 @@ ## Bladeburner.joinBladeburnerDivision() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Attempts to join the Bladeburner division. - -Returns true if you successfully join the Bladeburner division, or if you are already a member. - -Returns false otherwise. +Join the bladeburner division. Signature: @@ -27,3 +21,9 @@ True if you successfully join the Bladeburner division, or if you are already a 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. + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md index 31246eab2..d2db36826 100644 --- a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md +++ b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md @@ -4,13 +4,7 @@ ## Bladeburner.joinBladeburnerFaction() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Attempts to join the Bladeburner faction. - -Returns true if you successfully join the Bladeburner faction, or if you are already a member. - -Returns false otherwise. +Join the bladeburner faction. Signature: @@ -25,5 +19,9 @@ True if you successfully join the Bladeburner faction, or if you are already a m ## Remarks -RAM cost: 4 GB +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. diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md index 98e1af3c2..ea10612cc 100644 --- a/markdown/bitburner.bladeburner.md +++ b/markdown/bitburner.bladeburner.md @@ -4,6 +4,7 @@ ## Bladeburner interface +Bladeburner API Signature: @@ -11,42 +12,46 @@ export interface Bladeburner ``` +## 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. + ## Methods | Method | Description | | --- | --- | -| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Return a boolean indicating whether or not this action is currently set to autolevel.Returns false if an invalid action is specified. | -| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the remaining count of the specified action.Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. | -| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the current level of this action.Returns -1 if an invalid action is specified. | -| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). | -| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the maximum level for this action.Returns -1 if an invalid action is specified. | -| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. | -| [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of seconds it takes to complete the specified action | -| [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner Black Ops. | -| [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the rank required to complete this BlackOp.Returns -1 if an invalid action is specified. | -| [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. | -| [getCity()](./bitburner.bladeburner.getcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the city that the player is currently in (for Bladeburner). | -| [getCityChaos(name)](./bitburner.bladeburner.getcitychaos.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the chaos in the specified city, or -1 if an invalid city was specified. | -| [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. | -| [getCityEstimatedPopulation(name)](./bitburner.bladeburner.getcityestimatedpopulation.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. | -| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner contracts. | -| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. | -| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner actions. | -| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner operations. | -| [getRank()](./bitburner.bladeburner.getrank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the player’s Bladeburner Rank. | -| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns your level in the specified skill.The function returns -1 if an invalid skill name is passed in. | -| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner skills. | -| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner skill points you have. | -| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns the number of skill points needed to upgrade the specified skill.The function returns -1 if an invalid skill name is passed in. | -| [getStamina()](./bitburner.bladeburner.getstamina.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array with two elements: \* \[Current stamina, Max stamina\] | -| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner team members you have assigned to the specified action.Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. | -| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner division.Returns true if you successfully join the Bladeburner division, or if you are already a member.Returns false otherwise. | -| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner faction.Returns true if you successfully join the Bladeburner faction, or if you are already a member.Returns false otherwise. | -| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Enable/disable autoleveling for the specified action. | -| [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the level for the specified action. | -| [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the team size for the specified Bladeburner action.Returns the team size that was set, or -1 if the function failed. | -| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. | -| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Stops the current Bladeburner action. | -| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to switch to the specified city (for Bladeburner only).Returns true if successful, and false otherwise | -| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to upgrade the specified Bladeburner skill.Returns true if the skill is successfully upgraded, and false otherwise. | +| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get wether an action is set to autolevel. | +| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. | +| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. | +| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. | +| [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. | +| [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. | +| [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | Get bladeburner bonus time. | +| [getCity()](./bitburner.bladeburner.getcity.md) | Get current city. | +| [getCityChaos(name)](./bitburner.bladeburner.getcitychaos.md) | Get chaos of a city. | +| [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | Get number of communities in a city. | +| [getCityEstimatedPopulation(name)](./bitburner.bladeburner.getcityestimatedpopulation.md) | Get estimated population in city. | +| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | List all contracts. | +| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | Get current action. | +| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | List all general actions. | +| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | List all operations. | +| [getRank()](./bitburner.bladeburner.getrank.md) | Get player bladeburner rank. | +| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. | +| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. | +| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. | +| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. | +| [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. | +| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. | +| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. | +| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | Join the bladeburner faction. | +| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | Set an action autolevel. | +| [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | Set the level of an action. | +| [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | Set team size. | +| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. | +| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. | +| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. | +| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. | diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md index 7fcb416bd..73f708f0d 100644 --- a/markdown/bitburner.bladeburner.setactionautolevel.md +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -4,26 +4,20 @@ ## Bladeburner.setActionAutolevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Enable/disable autoleveling for the specified action. +Set an action autolevel. Signature: ```typescript -setActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - autoLevel: boolean, - ): void; +setActionAutolevel(type: string, name: string, autoLevel: boolean): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | | autoLevel | boolean | Whether or not to autolevel this action | Returns: @@ -34,3 +28,5 @@ void RAM cost: 4 GB +Enable/disable autoleveling for the specified action. + diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md index 65537f318..398bde4dd 100644 --- a/markdown/bitburner.bladeburner.setactionlevel.md +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -4,26 +4,20 @@ ## Bladeburner.setActionLevel() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Set the level for the specified action. +Set the level of an action. Signature: ```typescript -setActionLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): void; +setActionLevel(type: string, name: string, level: number): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | | level | number | Level to set this action to. | Returns: @@ -34,3 +28,5 @@ void RAM cost: 4 GB +Set the level for the specified action. + diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md index 4c7a99610..13a848cbe 100644 --- a/markdown/bitburner.bladeburner.setteamsize.md +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -4,28 +4,20 @@ ## Bladeburner.setTeamSize() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Set the team size for the specified Bladeburner action. - -Returns the team size that was set, or -1 if the function failed. +Set team size. Signature: ```typescript -setTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - size: number, - ): number; +setTeamSize(type: string, name: string, size: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| type | string | Type of action. | +| 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: @@ -38,3 +30,7 @@ Number of Bladeburner team members you assigned to the specified action. 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. + diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md index b821367a0..4d3af78db 100644 --- a/markdown/bitburner.bladeburner.startaction.md +++ b/markdown/bitburner.bladeburner.startaction.md @@ -4,25 +4,20 @@ ## Bladeburner.startAction() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. +Start an action. Signature: ```typescript -startAction( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; +startAction(type: string, name: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | -| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match | Returns: @@ -34,3 +29,5 @@ True if the action was started successfully, and false otherwise. RAM cost: 4 GB +Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. + diff --git a/markdown/bitburner.bladeburner.stopbladeburneraction.md b/markdown/bitburner.bladeburner.stopbladeburneraction.md index 1c5c59738..2542767e6 100644 --- a/markdown/bitburner.bladeburner.stopbladeburneraction.md +++ b/markdown/bitburner.bladeburner.stopbladeburneraction.md @@ -4,9 +4,7 @@ ## Bladeburner.stopBladeburnerAction() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Stops the current Bladeburner action. +Stop current action. Signature: @@ -21,3 +19,5 @@ void RAM cost: 2 GB +Stops the current Bladeburner action. + diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md index 977b3cd96..77e414a9a 100644 --- a/markdown/bitburner.bladeburner.switchcity.md +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -4,23 +4,19 @@ ## Bladeburner.switchCity() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Attempts to switch to the specified city (for Bladeburner only). - -Returns true if successful, and false otherwise +Travel to another city in bladeburner. Signature: ```typescript -switchCity(name: City): boolean; +switchCity(name: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [City](./bitburner.city.md) | | +| name | string | | Returns: @@ -30,5 +26,7 @@ true if successful, and false otherwise ## Remarks -RAM cost: 4 GB +RAM cost: 4 GB Attempts to switch to the specified city (for Bladeburner only). + +Returns true if successful, and false otherwise diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md index 7765eceae..47b741480 100644 --- a/markdown/bitburner.bladeburner.upgradeskill.md +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -4,23 +4,19 @@ ## Bladeburner.upgradeSkill() method -You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. - -Attempts to upgrade the specified Bladeburner skill. - -Returns true if the skill is successfully upgraded, and false otherwise. +Upgrade skill. Signature: ```typescript -upgradeSkill(name: BladeburnerSkills): boolean; +upgradeSkill(name: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | +| name | string | | Returns: @@ -32,3 +28,7 @@ true if the skill is successfully upgraded, and false otherwise. RAM cost: 4 GB +Attempts to upgrade the specified Bladeburner skill. + +Returns true if the skill is successfully upgraded, and false otherwise. + diff --git a/markdown/bitburner.bladeburneracttypes.md b/markdown/bitburner.bladeburneracttypes.md deleted file mode 100644 index cc2d4ab05..000000000 --- a/markdown/bitburner.bladeburneracttypes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) - -## BladeburnerActTypes type - -All Bladeburner action types. - -Signature: - -```typescript -type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; -``` diff --git a/markdown/bitburner.bladeburnerblackops.md b/markdown/bitburner.bladeburnerblackops.md deleted file mode 100644 index 61e206408..000000000 --- a/markdown/bitburner.bladeburnerblackops.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) - -## BladeburnerBlackOps type - -All Bladeburner black ops. - -Signature: - -```typescript -type BladeburnerBlackOps = - | "Operation Typhoon" - | "Operation Zero" - | "Operation X" - | "Operation Titan" - | "Operation Ares" - | "Operation Archangel" - | "Operation Juggernaut" - | "Operation Red Dragon" - | "Operation K" - | "Operation Deckard" - | "Operation Tyrell" - | "Operation Wallace" - | "Operation Shoulder of Orion" - | "Operation Hyron" - | "Operation Morpheus" - | "Operation Ion Storm" - | "Operation Annihilus" - | "Operation Ultron" - | "Operation Centurion" - | "Operation Vindictus" - | "Operation Daedalus"; -``` diff --git a/markdown/bitburner.bladeburnercontracts.md b/markdown/bitburner.bladeburnercontracts.md deleted file mode 100644 index 1865b1c95..000000000 --- a/markdown/bitburner.bladeburnercontracts.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerContracts](./bitburner.bladeburnercontracts.md) - -## BladeburnerContracts type - - -Signature: - -```typescript -type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; -``` diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md index b47c929a3..596804d5f 100644 --- a/markdown/bitburner.bladeburnercuraction.md +++ b/markdown/bitburner.bladeburnercuraction.md @@ -16,6 +16,6 @@ interface BladeburnerCurAction | Property | Type | Description | | --- | --- | --- | -| [name](./bitburner.bladeburnercuraction.name.md) | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of Action | -| [type](./bitburner.bladeburnercuraction.type.md) | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) \| "Idle" | Type of Action | +| [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 23a38ff9b..3dbcfe79b 100644 --- a/markdown/bitburner.bladeburnercuraction.name.md +++ b/markdown/bitburner.bladeburnercuraction.name.md @@ -9,5 +9,5 @@ Name of Action Signature: ```typescript -name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; +name: string; ``` diff --git a/markdown/bitburner.bladeburnercuraction.type.md b/markdown/bitburner.bladeburnercuraction.type.md index 0e5078292..63e21aec4 100644 --- a/markdown/bitburner.bladeburnercuraction.type.md +++ b/markdown/bitburner.bladeburnercuraction.type.md @@ -9,5 +9,5 @@ Type of Action Signature: ```typescript -type: BladeburnerActTypes | "Idle"; +type: string; ``` diff --git a/markdown/bitburner.bladeburnergenactions.md b/markdown/bitburner.bladeburnergenactions.md deleted file mode 100644 index fe2af3a5b..000000000 --- a/markdown/bitburner.bladeburnergenactions.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) - -## BladeburnerGenActions type - -All Bladeburner General Actions. - -Signature: - -```typescript -type BladeburnerGenActions = - | "Training" - | "Field Analysis" - | "Recruitment" - | "Diplomacy" - | "Hyperbolic Regeneration Chamber"; -``` diff --git a/markdown/bitburner.bladeburneroperations.md b/markdown/bitburner.bladeburneroperations.md deleted file mode 100644 index 84056da2a..000000000 --- a/markdown/bitburner.bladeburneroperations.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerOperations](./bitburner.bladeburneroperations.md) - -## BladeburnerOperations type - -All Bladeburner Ops. - -Signature: - -```typescript -type BladeburnerOperations = - | "Investigation" - | "Undercover Operation" - | "Sting Operation" - | "Raid" - | "Stealth Retirement Operation" - | "Assassination"; -``` diff --git a/markdown/bitburner.bladeburnerskills.md b/markdown/bitburner.bladeburnerskills.md deleted file mode 100644 index db0345754..000000000 --- a/markdown/bitburner.bladeburnerskills.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerSkills](./bitburner.bladeburnerskills.md) - -## BladeburnerSkills type - -All Bladeburner Skills. - -Signature: - -```typescript -type BladeburnerSkills = - | "Blade's Intuition" - | "Cloak" - | "Marksman" - | "Weapon Proficiency" - | "Short-Circuit" - | "Digital Observer" - | "Tracer" - | "Overclock" - | "Reaper" - | "Evasive System" - | "Datamancer" - | "Cyber's Edge" - | "Hands of Midas" - | "Hyperdrive"; -``` diff --git a/markdown/bitburner.characterinfo.city.md b/markdown/bitburner.characterinfo.city.md index 1a5e41ed3..305e71f08 100644 --- a/markdown/bitburner.characterinfo.city.md +++ b/markdown/bitburner.characterinfo.city.md @@ -9,5 +9,5 @@ Name of city you are currently in Signature: ```typescript -city: City; +city: string; ``` diff --git a/markdown/bitburner.characterinfo.company.md b/markdown/bitburner.characterinfo.company.md index dd9555acb..6284c261a 100644 --- a/markdown/bitburner.characterinfo.company.md +++ b/markdown/bitburner.characterinfo.company.md @@ -9,5 +9,5 @@ Array of all companies at which you have jobs Signature: ```typescript -company: CompanyName[]; +company: string[]; ``` diff --git a/markdown/bitburner.characterinfo.factions.md b/markdown/bitburner.characterinfo.factions.md index 225b9e789..5dc67e505 100644 --- a/markdown/bitburner.characterinfo.factions.md +++ b/markdown/bitburner.characterinfo.factions.md @@ -9,5 +9,5 @@ Array of factions you are currently a member of Signature: ```typescript -factions: FactionName[]; +factions: string[]; ``` diff --git a/markdown/bitburner.characterinfo.jobtitle.md b/markdown/bitburner.characterinfo.jobtitle.md index 1cd212d12..6b0e52d07 100644 --- a/markdown/bitburner.characterinfo.jobtitle.md +++ b/markdown/bitburner.characterinfo.jobtitle.md @@ -9,5 +9,5 @@ Array of job positions for all companies you are employed at. Same order as 'job Signature: ```typescript -jobTitle: CompanyField[]; +jobTitle: string[]; ``` diff --git a/markdown/bitburner.characterinfo.md b/markdown/bitburner.characterinfo.md index fdcf1ed80..cdf6f5c9a 100644 --- a/markdown/bitburner.characterinfo.md +++ b/markdown/bitburner.characterinfo.md @@ -16,11 +16,11 @@ interface CharacterInfo | Property | Type | Description | | --- | --- | --- | | [bitnode](./bitburner.characterinfo.bitnode.md) | number | Current BitNode number | -| [city](./bitburner.characterinfo.city.md) | [City](./bitburner.city.md) | Name of city you are currently in | -| [company](./bitburner.characterinfo.company.md) | [CompanyName](./bitburner.companyname.md)\[\] | Array of all companies at which you have jobs | -| [factions](./bitburner.characterinfo.factions.md) | [FactionName](./bitburner.factionname.md)\[\] | Array of factions you are currently a member of | +| [city](./bitburner.characterinfo.city.md) | string | Name of city you are currently in | +| [company](./bitburner.characterinfo.company.md) | string\[\] | Array of all companies at which you have jobs | +| [factions](./bitburner.characterinfo.factions.md) | string\[\] | Array of factions you are currently a member of | | [hp](./bitburner.characterinfo.hp.md) | number | Current health points | -| [jobTitle](./bitburner.characterinfo.jobtitle.md) | [CompanyField](./bitburner.companyfield.md)\[\] | Array of job positions for all companies you are employed at. Same order as 'jobs' | +| [jobTitle](./bitburner.characterinfo.jobtitle.md) | string\[\] | Array of job positions for all companies you are employed at. Same order as 'jobs' | | [maxHp](./bitburner.characterinfo.maxhp.md) | number | Maximum health points | | [mult](./bitburner.characterinfo.mult.md) | [CharacterMult](./bitburner.charactermult.md) | Object with many of the player's multipliers from Augmentations/Source Files | | [timeWorked](./bitburner.characterinfo.timeworked.md) | number | Timed worked in ms | diff --git a/markdown/bitburner.city.md b/markdown/bitburner.city.md deleted file mode 100644 index 60e143028..000000000 --- a/markdown/bitburner.city.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [City](./bitburner.city.md) - -## City type - -All cities. - -Signature: - -```typescript -type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; -``` diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md index 20522e20d..677a5de0c 100644 --- a/markdown/bitburner.codingcontract.attempt.md +++ b/markdown/bitburner.codingcontract.attempt.md @@ -4,21 +4,21 @@ ## CodingContract.attempt() method -Attempts to solve the Coding Contract with the provided solution. +Attemps a coding contract. Signature: ```typescript -attempt(answer: string | string[] | number, fn: string, host?: string): boolean; +attempt(answer: string[] | number, fn: string, host?: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| answer | string \| string\[\] \| number | Solution for the contract. | +| answer | string\[\] \| number | Solution for the contract. | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | Returns: @@ -28,5 +28,7 @@ True if the solution was correct, false otherwise. ## Remarks -10 GB +RAM cost: 10 GB + +Attempts to solve the Coding Contract with the provided solution. diff --git a/markdown/bitburner.codingcontract.attempt_1.md b/markdown/bitburner.codingcontract.attempt_1.md index bd5de9074..13973c1f3 100644 --- a/markdown/bitburner.codingcontract.attempt_1.md +++ b/markdown/bitburner.codingcontract.attempt_1.md @@ -4,21 +4,21 @@ ## CodingContract.attempt() method -Attempts to solve the Coding Contract with the provided solution. +Attemps a coding contract. Signature: ```typescript -attempt(answer: string | string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string; +attempt(answer: string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| answer | string \| string\[\] \| number | Solution for the contract. | +| answer | string\[\] \| number | Solution for the contract. | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | | opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. | Returns: @@ -29,5 +29,7 @@ True if the solution was correct, false otherwise. If the returnReward option is ## Remarks -10 GB +RAM cost: 10 GB + +Attempts to solve the Coding Contract with the provided solution. diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md index 84d2ff046..a91e07eca 100644 --- a/markdown/bitburner.codingcontract.getcontracttype.md +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -4,12 +4,12 @@ ## CodingContract.getContractType() method -Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) +Get the type of a coding contract. Signature: ```typescript -getContractType(fn: string, host?: string): CodingContractTypes; +getContractType(fn: string, host?: string): string; ``` ## Parameters @@ -17,11 +17,11 @@ getContractType(fn: string, host?: string): CodingContractTypes; | Parameter | Type | Description | | --- | --- | --- | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | Returns: -[CodingContractTypes](./bitburner.codingcontracttypes.md) +string Name describing the type of problem posed by the Coding Contract. @@ -29,3 +29,5 @@ Name describing the type of problem posed by the Coding Contract. 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.) + diff --git a/markdown/bitburner.codingcontract.getdata.md b/markdown/bitburner.codingcontract.getdata.md index fc1841feb..9d812e6bd 100644 --- a/markdown/bitburner.codingcontract.getdata.md +++ b/markdown/bitburner.codingcontract.getdata.md @@ -4,7 +4,7 @@ ## CodingContract.getData() method -Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve +Get the input data. Signature: @@ -17,7 +17,7 @@ getData(fn: string, host?: string): string; | Parameter | Type | Description | | --- | --- | --- | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | Returns: @@ -29,3 +29,5 @@ The specified contract’s data; 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 + diff --git a/markdown/bitburner.codingcontract.getdescription.md b/markdown/bitburner.codingcontract.getdescription.md index c1f1f2bf2..3d449443d 100644 --- a/markdown/bitburner.codingcontract.getdescription.md +++ b/markdown/bitburner.codingcontract.getdescription.md @@ -4,7 +4,7 @@ ## CodingContract.getDescription() method -Get the full text description for the problem posed by the Coding Contract. +Get the description. Signature: @@ -17,7 +17,7 @@ getDescription(fn: string, host?: string): string; | Parameter | Type | Description | | --- | --- | --- | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | Returns: @@ -29,3 +29,5 @@ Contract’s text description. RAM cost: 5 GB +Get the full text description for the problem posed by the Coding Contract. + diff --git a/markdown/bitburner.codingcontract.getnumtriesremaining.md b/markdown/bitburner.codingcontract.getnumtriesremaining.md index d5c513f46..dcc5ed121 100644 --- a/markdown/bitburner.codingcontract.getnumtriesremaining.md +++ b/markdown/bitburner.codingcontract.getnumtriesremaining.md @@ -4,7 +4,7 @@ ## CodingContract.getNumTriesRemaining() method -Get the number of tries remaining on the contract before it self-destructs. +Get the number of attempt remaining. Signature: @@ -17,7 +17,7 @@ getNumTriesRemaining(fn: string, host?: string): number; | Parameter | Type | Description | | --- | --- | --- | | fn | string | Filename of the contract. | -| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | Returns: @@ -29,3 +29,5 @@ How many attempts are remaining for the contract; RAM cost: 2 GB +Get the number of tries remaining on the contract before it self-destructs. + diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md index 727984b1a..c65555bd8 100644 --- a/markdown/bitburner.codingcontract.md +++ b/markdown/bitburner.codingcontract.md @@ -16,10 +16,10 @@ interface CodingContract | Method | Description | | --- | --- | -| [attempt(answer, fn, host)](./bitburner.codingcontract.attempt.md) | Attempts to solve the Coding Contract with the provided solution. | -| [attempt(answer, fn, host, opts)](./bitburner.codingcontract.attempt_1.md) | Attempts to solve the Coding Contract with the provided solution. | -| [getContractType(fn, host)](./bitburner.codingcontract.getcontracttype.md) | Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) | -| [getData(fn, host)](./bitburner.codingcontract.getdata.md) | Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve | -| [getDescription(fn, host)](./bitburner.codingcontract.getdescription.md) | Get the full text description for the problem posed by the Coding Contract. | -| [getNumTriesRemaining(fn, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of tries remaining on the contract before it self-destructs. | +| [attempt(answer, fn, host)](./bitburner.codingcontract.attempt.md) | Attemps a coding contract. | +| [attempt(answer, fn, host, opts)](./bitburner.codingcontract.attempt_1.md) | Attemps a coding contract. | +| [getContractType(fn, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. | +| [getData(fn, host)](./bitburner.codingcontract.getdata.md) | Get the input data. | +| [getDescription(fn, host)](./bitburner.codingcontract.getdescription.md) | Get the description. | +| [getNumTriesRemaining(fn, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempt remaining. | diff --git a/markdown/bitburner.codingcontracttypes.md b/markdown/bitburner.codingcontracttypes.md deleted file mode 100644 index 93c52f4f4..000000000 --- a/markdown/bitburner.codingcontracttypes.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContractTypes](./bitburner.codingcontracttypes.md) - -## CodingContractTypes type - -All Coding contract types. - -Signature: - -```typescript -type CodingContractTypes = - | "Find Largest Prime Factor" - | "Subarray with Maximum Sum" - | "Total Ways to Sum" - | "Spiralize Matrix" - | "Array Jumping Game" - | "Merge Overlapping Intervals" - | "Generate IP Addresses" - | "Algorithmic Stock Trader I" - | "Algorithmic Stock Trader II" - | "Algorithmic Stock Trader III" - | "Algorithmic Stock Trader IV" - | "Minimum Path Sum in a Triangle" - | "Unique Paths in a Grid I" - | "Unique Paths in a Grid II" - | "Sanitize Parentheses in Expression" - | "Find All Valid Math Expressions"; -``` diff --git a/markdown/bitburner.companyfield.md b/markdown/bitburner.companyfield.md deleted file mode 100644 index ffe0fda02..000000000 --- a/markdown/bitburner.companyfield.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyField](./bitburner.companyfield.md) - -## CompanyField type - -All company work fields. - -Signature: - -```typescript -type CompanyField = - | "software" - | "software consultant" - | "it" - | "security engineer" - | "network engineer" - | "business" - | "business consultant" - | "security" - | "agent" - | "employee" - | "part-time employee" - | "waiter" - | "part-time waiter"; -``` diff --git a/markdown/bitburner.companyname.md b/markdown/bitburner.companyname.md deleted file mode 100644 index 3dcda08d1..000000000 --- a/markdown/bitburner.companyname.md +++ /dev/null @@ -1,62 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyName](./bitburner.companyname.md) - -## CompanyName type - -All companies. - -Signature: - -```typescript -type CompanyName = - // Sector-12 - | "MegaCorp" - | "BladeIndustries" - | "FourSigma" - | "IcarusMicrosystems" - | "UniversalEnergy" - | "DeltaOne" - | "CIA" - | "NSA" - | "AlphaEnterprises" - | "CarmichaelSecurity" - | "FoodNStuff" - | "JoesGuns" - - // Aevum - | "ECorp" - | "BachmanAndAssociates" - | "ClarkeIncorporated" - | "OmniTekIncorporated" - | "FulcrumTechnologies" - | "GalacticCybersystems" - | "AeroCorp" - | "WatchdogSecurity" - | "RhoConstruction" - | "AevumPolice" - | "NetLinkTechnologies" - - // Volhaven - | "NWO" - | "HeliosLabs" - | "OmniaCybersystems" - | "LexoCorp" - | "SysCoreSecurities" - | "CompuTek" - - // Chongqing - | "KuaiGongInternational" - | "SolarisSpaceSystems" - - // Ishima - | "StormTechnologies" - | "NovaMedical" - | "OmegaSoftware" - - // New Tokyo - | "DefComm" - | "VitaLife" - | "GlobalPharmaceuticals" - | "NoodleBar"; -``` diff --git a/markdown/bitburner.crime.md b/markdown/bitburner.crime.md deleted file mode 100644 index 1869bf65a..000000000 --- a/markdown/bitburner.crime.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Crime](./bitburner.crime.md) - -## Crime type - -All crimes. - -Signature: - -```typescript -type Crime = - | "shoplift" - | "rob store" - | "mug" - | "larceny" - | "deal drugs" - | "bond forgery" - | "traffick arms" - | "homicide" - | "grand theft auto" - | "kidnap" - | "assassinate" - | "heist"; -``` diff --git a/markdown/bitburner.factionname.md b/markdown/bitburner.factionname.md deleted file mode 100644 index 5ecd3d159..000000000 --- a/markdown/bitburner.factionname.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [FactionName](./bitburner.factionname.md) - -## FactionName type - -All factions. - -Signature: - -```typescript -type FactionName = - | "Illuminati" - | "Daedalus" - | "The Covenant" - | "ECorp" - | "MegaCorp" - | "Bachman & Associates" - | "Blade Industries" - | "NWO" - | "Clarke Incorporated" - | "OmniTek Incorporated" - | "Four Sigma" - | "KuaiGong International" - | "Fulcrum Secret Technologies" - | "BitRunners" - | "The Black Hand" - | "NiteSec" - | "Aevum" - | "Chongqing" - | "Ishima" - | "New Tokyo" - | "Sector-12" - | "Volhaven" - | "Speakers for the Dead" - | "The Dark Army" - | "The Syndicate" - | "Silhouette" - | "Tetrads" - | "Slum Snakes" - | "Netburners" - | "Tian Di Hui" - | "CyberSec" - | "Bladeburners"; -``` diff --git a/markdown/bitburner.factionwork.md b/markdown/bitburner.factionwork.md deleted file mode 100644 index d3dcf6cc7..000000000 --- a/markdown/bitburner.factionwork.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [FactionWork](./bitburner.factionwork.md) - -## FactionWork type - -All faction work types. - -Signature: - -```typescript -type FactionWork = "hacking" | "field" | "security"; -``` diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md index 6ff331f15..93db97656 100644 --- a/markdown/bitburner.gang.ascendmember.md +++ b/markdown/bitburner.gang.ascendmember.md @@ -4,9 +4,7 @@ ## Gang.ascendMember() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Ascend the specified Gang Member. +Ascend a gang member. Signature: @@ -30,3 +28,5 @@ Object with info about the ascension results. RAM cost: 4 GB +Ascend the specified Gang Member. + diff --git a/markdown/bitburner.gang.canrecruitmember.md b/markdown/bitburner.gang.canrecruitmember.md index a6b6c9dc7..5710fed44 100644 --- a/markdown/bitburner.gang.canrecruitmember.md +++ b/markdown/bitburner.gang.canrecruitmember.md @@ -4,9 +4,7 @@ ## Gang.canRecruitMember() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Returns boolean indicating whether a member can currently be recruited +Check if you can recruit a new gang member. Signature: @@ -23,3 +21,5 @@ True if a member can currently be recruited, false otherwise. RAM cost: 1 GB +Returns boolean indicating whether a member can currently be recruited + diff --git a/markdown/bitburner.gang.getbonustime.md b/markdown/bitburner.gang.getbonustime.md index 651a6dc00..adc5430ce 100644 --- a/markdown/bitburner.gang.getbonustime.md +++ b/markdown/bitburner.gang.getbonustime.md @@ -4,13 +4,7 @@ ## Gang.getBonusTime() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. - -“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. - -“Bonus time” makes the game progress faster, up to 10x the normal speed. +Get bonus time. Signature: @@ -21,9 +15,15 @@ getBonusTime(): number; number -Bonus time for the Gang mechanic in seconds. +Bonus time for the Gang mechanic in milliseconds. ## Remarks RAM cost: 0 GB +Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 10x the normal speed. + diff --git a/markdown/bitburner.gang.getchancetowinclash.md b/markdown/bitburner.gang.getchancetowinclash.md index aa4e0a121..fa6d46455 100644 --- a/markdown/bitburner.gang.getchancetowinclash.md +++ b/markdown/bitburner.gang.getchancetowinclash.md @@ -4,21 +4,19 @@ ## Gang.getChanceToWinClash() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage +Get chance to win clash with other gang. Signature: ```typescript -getChanceToWinClash(gangName: GangName): number; +getChanceToWinClash(gangName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| gangName | [GangName](./bitburner.gangname.md) | Target gang | +| gangName | string | Target gang | Returns: @@ -30,3 +28,5 @@ Chance you have to win a clash with the specified gang. 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 + diff --git a/markdown/bitburner.gang.getequipmentcost.md b/markdown/bitburner.gang.getequipmentcost.md index 32afc6bb2..8deb184e4 100644 --- a/markdown/bitburner.gang.getequipmentcost.md +++ b/markdown/bitburner.gang.getequipmentcost.md @@ -4,21 +4,19 @@ ## Gang.getEquipmentCost() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. +Get cost of equipment. Signature: ```typescript -getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; +getEquipmentCost(equipName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | +| equipName | string | Name of equipment. | Returns: @@ -30,3 +28,5 @@ Cost to purchase the specified Equipment/Augmentation (number). Infinity for inv 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. + diff --git a/markdown/bitburner.gang.getequipmentnames.md b/markdown/bitburner.gang.getequipmentnames.md index 39ba35c9a..84d75e423 100644 --- a/markdown/bitburner.gang.getequipmentnames.md +++ b/markdown/bitburner.gang.getequipmentnames.md @@ -4,18 +4,16 @@ ## Gang.getEquipmentNames() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. +List equipment names. Signature: ```typescript -getEquipmentNames(): (GangEquipment | GangAugmentations)[]; +getEquipmentNames(): string[]; ``` Returns: -([GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md))\[\] +string\[\] Names of all Equpiment/Augmentations. @@ -23,3 +21,5 @@ Names of all Equpiment/Augmentations. RAM cost: 1 GB +Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. + diff --git a/markdown/bitburner.gang.getequipmentstats.md b/markdown/bitburner.gang.getequipmentstats.md index 431ca7e5f..6b68d1889 100644 --- a/markdown/bitburner.gang.getequipmentstats.md +++ b/markdown/bitburner.gang.getequipmentstats.md @@ -4,25 +4,23 @@ ## Gang.getEquipmentStats() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the specified equipment stats. +Get stats of an equipment. Signature: ```typescript -getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; +getEquipmentStats(equipName: string): stringStats; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | +| equipName | string | Name of equipment. | Returns: -[GangEquipmentStats](./bitburner.gangequipmentstats.md) +[stringStats](./bitburner.stringstats.md) A dictionary containing the stats of the equipment. @@ -30,3 +28,5 @@ A dictionary containing the stats of the equipment. RAM cost: 2 GB +Get the specified equipment stats. + diff --git a/markdown/bitburner.gang.getequipmenttype.md b/markdown/bitburner.gang.getequipmenttype.md index e35c0b53e..0958e5696 100644 --- a/markdown/bitburner.gang.getequipmenttype.md +++ b/markdown/bitburner.gang.getequipmenttype.md @@ -4,25 +4,23 @@ ## Gang.getEquipmentType() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the specified equipment type. +Get type of an equipment. Signature: ```typescript -getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; +getEquipmentType(equipName: string): string; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | +| equipName | string | Name of equipment. | Returns: -[GangEquipmentType](./bitburner.gangequipmenttype.md) +string Type of the equipment. @@ -30,3 +28,5 @@ Type of the equipment. RAM cost: 2 GB +Get the specified equipment type. + diff --git a/markdown/bitburner.gang.getganginformation.md b/markdown/bitburner.gang.getganginformation.md index 4ff2c819a..5e325c073 100644 --- a/markdown/bitburner.gang.getganginformation.md +++ b/markdown/bitburner.gang.getganginformation.md @@ -4,9 +4,7 @@ ## Gang.getGangInformation() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get general information about the gang. +Get information about your gang. Signature: @@ -23,3 +21,5 @@ Object containing general information about the gang. RAM cost: 2 GB +Get general information about the gang. + diff --git a/markdown/bitburner.gang.getmemberinformation.md b/markdown/bitburner.gang.getmemberinformation.md index 60da757d6..13033bfaa 100644 --- a/markdown/bitburner.gang.getmemberinformation.md +++ b/markdown/bitburner.gang.getmemberinformation.md @@ -4,9 +4,7 @@ ## Gang.getMemberInformation() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get stat and equipment-related information about a Gang Member +Get information about a specific gang member. Signature: @@ -30,3 +28,5 @@ Object containing stat and equipment-related information about a Gang Member. RAM cost: 2 GB +Get stat and equipment-related information about a Gang Member + diff --git a/markdown/bitburner.gang.getmembernames.md b/markdown/bitburner.gang.getmembernames.md index c51eba710..08a766c42 100644 --- a/markdown/bitburner.gang.getmembernames.md +++ b/markdown/bitburner.gang.getmembernames.md @@ -4,9 +4,7 @@ ## Gang.getMemberNames() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the names of all Gang members +List all gang members. Signature: @@ -23,3 +21,5 @@ Names of all Gang members. RAM cost: 1 GB +Get the names of all Gang members + diff --git a/markdown/bitburner.gang.getotherganginformation.md b/markdown/bitburner.gang.getotherganginformation.md index da3ae7088..6764033f3 100644 --- a/markdown/bitburner.gang.getotherganginformation.md +++ b/markdown/bitburner.gang.getotherganginformation.md @@ -4,9 +4,7 @@ ## Gang.getOtherGangInformation() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get territory and power information about all gangs. +Get information about the other gangs. Signature: @@ -23,3 +21,5 @@ Object containing territory and power information about all gangs. RAM cost: 2 GB +Get territory and power information about all gangs. + diff --git a/markdown/bitburner.gang.gettasknames.md b/markdown/bitburner.gang.gettasknames.md index e294a42f2..4e1b1d885 100644 --- a/markdown/bitburner.gang.gettasknames.md +++ b/markdown/bitburner.gang.gettasknames.md @@ -4,18 +4,16 @@ ## Gang.getTaskNames() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the name of all valid tasks that Gang members can be assigned to. +List member task names. Signature: ```typescript -getTaskNames(): GangTasks[]; +getTaskNames(): string[]; ``` Returns: -[GangTasks](./bitburner.gangtasks.md)\[\] +string\[\] All valid tasks that Gang members can be assigned to. @@ -23,3 +21,5 @@ All valid tasks that Gang members can be assigned to. RAM cost: 1 GB +Get the name of all valid tasks that Gang members can be assigned to. + diff --git a/markdown/bitburner.gang.gettaskstats.md b/markdown/bitburner.gang.gettaskstats.md index b435e593f..dc104b940 100644 --- a/markdown/bitburner.gang.gettaskstats.md +++ b/markdown/bitburner.gang.gettaskstats.md @@ -4,25 +4,23 @@ ## Gang.getTaskStats() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. +Get stats of a task. Signature: ```typescript -getTaskStats(name: GangTasks): GangTasksStats; +getTaskStats(name: string): stringStats; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [GangTasks](./bitburner.gangtasks.md) | Name of the task. | +| name | string | Name of the task. | Returns: -[GangTasksStats](./bitburner.gangtasksstats.md) +[stringStats](./bitburner.stringstats.md) Detailed stats of a task. @@ -30,3 +28,5 @@ Detailed stats of a task. RAM cost: 1 GB +Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. + diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md index 529a0cb5d..978fb28c7 100644 --- a/markdown/bitburner.gang.md +++ b/markdown/bitburner.gang.md @@ -12,26 +12,30 @@ Gang API interface Gang ``` +## Remarks + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this API. + ## Methods | Method | Description | | --- | --- | -| [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Ascend the specified Gang Member. | -| [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns boolean indicating whether a member can currently be recruited | -| [getBonusTime()](./bitburner.gang.getbonustime.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.“Bonus time” makes the game progress faster, up to 10x the normal speed. | -| [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage | -| [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. | -| [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. | -| [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment stats. | -| [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment type. | -| [getGangInformation()](./bitburner.gang.getganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get general information about the gang. | -| [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get stat and equipment-related information about a Gang Member | -| [getMemberNames()](./bitburner.gang.getmembernames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the names of all Gang members | -| [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get territory and power information about all gangs. | -| [getTaskNames()](./bitburner.gang.gettasknames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all valid tasks that Gang members can be assigned to. | -| [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. | -| [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. | -| [recruitMember(name)](./bitburner.gang.recruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempt to recruit a new gang member.Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name | -| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). | -| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Set whether or not the gang should engage in territory warfare | +| [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | Ascend a gang member. | +| [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | Check if you can recruit a new gang member. | +| [getBonusTime()](./bitburner.gang.getbonustime.md) | Get bonus time. | +| [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | Get chance to win clash with other gang. | +| [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | Get cost of equipment. | +| [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | List equipment names. | +| [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | Get stats of an equipment. | +| [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | Get type of an equipment. | +| [getGangInformation()](./bitburner.gang.getganginformation.md) | Get information about your gang. | +| [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | Get information about a specific gang member. | +| [getMemberNames()](./bitburner.gang.getmembernames.md) | List all gang members. | +| [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | Get information about the other gangs. | +| [getTaskNames()](./bitburner.gang.gettasknames.md) | List member task names. | +| [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | Get stats of a task. | +| [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | Purchase an equipment for a gang member. | +| [recruitMember(name)](./bitburner.gang.recruitmember.md) | Recruit a new gang member. | +| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | Set gang member to task. | +| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | Enable/Disable territory warfare. | diff --git a/markdown/bitburner.gang.purchaseequipment.md b/markdown/bitburner.gang.purchaseequipment.md index 342333da4..c5cb20db2 100644 --- a/markdown/bitburner.gang.purchaseequipment.md +++ b/markdown/bitburner.gang.purchaseequipment.md @@ -4,14 +4,12 @@ ## Gang.purchaseEquipment() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. +Purchase an equipment for a gang member. Signature: ```typescript -purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; +purchaseEquipment(memberName: string, equipName: string): boolean; ``` ## Parameters @@ -19,7 +17,7 @@ purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentatio | Parameter | Type | Description | | --- | --- | --- | | memberName | string | Name of Gang member to purchase the equipment for. | -| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of Equipment/Augmentation to purchase. | +| equipName | string | Name of Equipment/Augmentation to purchase. | Returns: @@ -31,3 +29,5 @@ True if the equipment was successfully purchased. False otherwise RAM cost: 4 GB +Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. + diff --git a/markdown/bitburner.gang.recruitmember.md b/markdown/bitburner.gang.recruitmember.md index 8df4b5a67..d74689ed8 100644 --- a/markdown/bitburner.gang.recruitmember.md +++ b/markdown/bitburner.gang.recruitmember.md @@ -4,11 +4,7 @@ ## Gang.recruitMember() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Attempt to recruit a new gang member. - -Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name +Recruit a new gang member. Signature: @@ -32,3 +28,7 @@ True if the member was successfully recruited, false otherwise. 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 + diff --git a/markdown/bitburner.gang.setmembertask.md b/markdown/bitburner.gang.setmembertask.md index f83187421..972af190b 100644 --- a/markdown/bitburner.gang.setmembertask.md +++ b/markdown/bitburner.gang.setmembertask.md @@ -4,14 +4,12 @@ ## Gang.setMemberTask() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). +Set gang member to task. Signature: ```typescript -setMemberTask(memberName: string, taskName: GangTasks): boolean; +setMemberTask(memberName: string, taskName: string): boolean; ``` ## Parameters @@ -19,7 +17,7 @@ setMemberTask(memberName: string, taskName: GangTasks): boolean; | Parameter | Type | Description | | --- | --- | --- | | memberName | string | Name of Gang member to assign. | -| taskName | [GangTasks](./bitburner.gangtasks.md) | Task to assign. | +| taskName | string | Task to assign. | Returns: @@ -31,3 +29,5 @@ True if the Gang Member was successfully assigned to the task, false otherwise. 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”). + diff --git a/markdown/bitburner.gang.setterritorywarfare.md b/markdown/bitburner.gang.setterritorywarfare.md index 2b5d03b0d..068b0abce 100644 --- a/markdown/bitburner.gang.setterritorywarfare.md +++ b/markdown/bitburner.gang.setterritorywarfare.md @@ -4,9 +4,7 @@ ## Gang.setTerritoryWarfare() method -If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. - -Set whether or not the gang should engage in territory warfare +Enable/Disable territory warfare. Signature: @@ -28,3 +26,5 @@ void RAM cost: 2 GB +Set whether or not the gang should engage in territory warfare + diff --git a/markdown/bitburner.gangaugmentations.md b/markdown/bitburner.gangaugmentations.md deleted file mode 100644 index f17fae97d..000000000 --- a/markdown/bitburner.gangaugmentations.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangAugmentations](./bitburner.gangaugmentations.md) - -## GangAugmentations type - -All Gang augmentations. - -Signature: - -```typescript -type GangAugmentations = - | "Bionic Arms" - | "Bionic Legs" - | "Bionic Spine" - | "BrachiBlades" - | "Nanofiber Weave" - | "Synthetic Heart" - | "Synfibril Muscle" - | "BitWire" - | "Neuralstimulator" - | "DataJack" - | "Graphene Bone Lacings"; -``` diff --git a/markdown/bitburner.gangequipment.md b/markdown/bitburner.gangequipment.md deleted file mode 100644 index 07862fbc1..000000000 --- a/markdown/bitburner.gangequipment.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipment](./bitburner.gangequipment.md) - -## GangEquipment type - -All Gang equipment. - -Signature: - -```typescript -type GangEquipment = - | "Baseball Bat" - | "Katana" - | "Glock 18C" - | "P90C" - | "Steyr AUG" - | "AK-47" - | "M15A10 Assault Rifle" - | "AWM Sniper Rifle" - | "Bulletproof Vest" - | "Full Body Armor" - | "Liquid Body Armor" - | "Graphene Plating Armor" - | "Ford Flex V20" - | "ATX1070 Superbike" - | "Mercedes-Benz S9001" - | "White Ferrari" - | "NUKE Rootkit" - | "Soulstealer Rootkit" - | "Demon Rootkit" - | "Hmap Node" - | "Jack the Ripper"; -``` diff --git a/markdown/bitburner.gangequipmentstats.agi.md b/markdown/bitburner.gangequipmentstats.agi.md deleted file mode 100644 index 392c3b24d..000000000 --- a/markdown/bitburner.gangequipmentstats.agi.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [agi](./bitburner.gangequipmentstats.agi.md) - -## GangEquipmentStats.agi property - -Agility multiplier - -Signature: - -```typescript -agi: number; -``` diff --git a/markdown/bitburner.gangequipmentstats.cha.md b/markdown/bitburner.gangequipmentstats.cha.md deleted file mode 100644 index 198f8bea6..000000000 --- a/markdown/bitburner.gangequipmentstats.cha.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [cha](./bitburner.gangequipmentstats.cha.md) - -## GangEquipmentStats.cha property - -Charisma multiplier - -Signature: - -```typescript -cha: number; -``` diff --git a/markdown/bitburner.gangequipmentstats.def.md b/markdown/bitburner.gangequipmentstats.def.md deleted file mode 100644 index 0f6b028f0..000000000 --- a/markdown/bitburner.gangequipmentstats.def.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [def](./bitburner.gangequipmentstats.def.md) - -## GangEquipmentStats.def property - -Defense multiplier - -Signature: - -```typescript -def: number; -``` diff --git a/markdown/bitburner.gangequipmentstats.dex.md b/markdown/bitburner.gangequipmentstats.dex.md deleted file mode 100644 index ebdcb5d27..000000000 --- a/markdown/bitburner.gangequipmentstats.dex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [dex](./bitburner.gangequipmentstats.dex.md) - -## GangEquipmentStats.dex property - -Dexterity multiplier - -Signature: - -```typescript -dex: number; -``` diff --git a/markdown/bitburner.gangequipmentstats.hack.md b/markdown/bitburner.gangequipmentstats.hack.md deleted file mode 100644 index 25f4f1ea3..000000000 --- a/markdown/bitburner.gangequipmentstats.hack.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [hack](./bitburner.gangequipmentstats.hack.md) - -## GangEquipmentStats.hack property - -Hacking multiplier - -Signature: - -```typescript -hack: number; -``` diff --git a/markdown/bitburner.gangequipmentstats.md b/markdown/bitburner.gangequipmentstats.md deleted file mode 100644 index c749c4bb4..000000000 --- a/markdown/bitburner.gangequipmentstats.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) - -## GangEquipmentStats interface - -Object representing data representing a gang member equipment. - -Signature: - -```typescript -interface GangEquipmentStats -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [agi](./bitburner.gangequipmentstats.agi.md) | number | Agility multiplier | -| [cha](./bitburner.gangequipmentstats.cha.md) | number | Charisma multiplier | -| [def](./bitburner.gangequipmentstats.def.md) | number | Defense multiplier | -| [dex](./bitburner.gangequipmentstats.dex.md) | number | Dexterity multiplier | -| [hack](./bitburner.gangequipmentstats.hack.md) | number | Hacking multiplier | -| [str](./bitburner.gangequipmentstats.str.md) | number | Strength multiplier | - diff --git a/markdown/bitburner.gangequipmentstats.str.md b/markdown/bitburner.gangequipmentstats.str.md deleted file mode 100644 index 945af13f8..000000000 --- a/markdown/bitburner.gangequipmentstats.str.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [str](./bitburner.gangequipmentstats.str.md) - -## GangEquipmentStats.str property - -Strength multiplier - -Signature: - -```typescript -str: number; -``` diff --git a/markdown/bitburner.gangequipmenttype.md b/markdown/bitburner.gangequipmenttype.md deleted file mode 100644 index 9d3afdbf8..000000000 --- a/markdown/bitburner.gangequipmenttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentType](./bitburner.gangequipmenttype.md) - -## GangEquipmentType type - -All Gang equipment type. - -Signature: - -```typescript -type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; -``` diff --git a/markdown/bitburner.ganggeninfo.faction.md b/markdown/bitburner.ganggeninfo.faction.md index a8242a2fe..0b36ac034 100644 --- a/markdown/bitburner.ganggeninfo.faction.md +++ b/markdown/bitburner.ganggeninfo.faction.md @@ -9,5 +9,5 @@ Name of faction that the gang belongs to ("Slum Snakes", etc.) Signature: ```typescript -faction: GangName; +faction: string; ``` diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md index fe5d78c6a..829cd37f2 100644 --- a/markdown/bitburner.ganggeninfo.md +++ b/markdown/bitburner.ganggeninfo.md @@ -16,7 +16,7 @@ interface GangGenInfo | Property | Type | Description | | --- | --- | --- | -| [faction](./bitburner.ganggeninfo.faction.md) | [GangName](./bitburner.gangname.md) | Name of faction that the gang belongs to ("Slum Snakes", etc.) | +| [faction](./bitburner.ganggeninfo.faction.md) | string | Name of faction that the gang belongs to ("Slum Snakes", etc.) | | [isHacking](./bitburner.ganggeninfo.ishacking.md) | boolean | Boolean indicating whether or not its a hacking gang | | [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | number | Money earned per second | | [power](./bitburner.ganggeninfo.power.md) | number | Gang's power for territory warfare | diff --git a/markdown/bitburner.gangmemberinfo.augmentations.md b/markdown/bitburner.gangmemberinfo.augmentations.md index de464b6e1..9a7ccaa6e 100644 --- a/markdown/bitburner.gangmemberinfo.augmentations.md +++ b/markdown/bitburner.gangmemberinfo.augmentations.md @@ -9,5 +9,5 @@ Array of names of all owned Augmentations Signature: ```typescript -augmentations: GangAugmentations[]; +augmentations: string[]; ``` diff --git a/markdown/bitburner.gangmemberinfo.equipment.md b/markdown/bitburner.gangmemberinfo.equipment.md index 513416db3..932a210ee 100644 --- a/markdown/bitburner.gangmemberinfo.equipment.md +++ b/markdown/bitburner.gangmemberinfo.equipment.md @@ -9,5 +9,5 @@ Array of names of all owned Non-Augmentation Equipment Signature: ```typescript -equipment: GangEquipment[]; +equipment: string[]; ``` diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md index 8e27df60d..9e4ec8cc1 100644 --- a/markdown/bitburner.gangmemberinfo.md +++ b/markdown/bitburner.gangmemberinfo.md @@ -18,7 +18,7 @@ interface GangMemberInfo | [agility](./bitburner.gangmemberinfo.agility.md) | number | Agility stat | | [agilityAscensionMult](./bitburner.gangmemberinfo.agilityascensionmult.md) | number | Agility multiplier from ascension. | | [agilityEquipMult](./bitburner.gangmemberinfo.agilityequipmult.md) | number | Agility multiplier from equipment. | -| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | [GangAugmentations](./bitburner.gangaugmentations.md)\[\] | Array of names of all owned Augmentations | +| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | string\[\] | Array of names of all owned Augmentations | | [charisma](./bitburner.gangmemberinfo.charisma.md) | number | Charisma stat | | [charismaAscensionMult](./bitburner.gangmemberinfo.charismaascensionmult.md) | number | Charisma multiplier from ascension. | | [charismaEquipMult](./bitburner.gangmemberinfo.charismaequipmult.md) | number | Charisma multiplier from equipment. | @@ -28,12 +28,12 @@ interface GangMemberInfo | [dexterity](./bitburner.gangmemberinfo.dexterity.md) | number | Dexterity stat | | [dexterityAscensionMult](./bitburner.gangmemberinfo.dexterityascensionmult.md) | number | Dexterity multiplier from ascension. | | [dexterityEquipMult](./bitburner.gangmemberinfo.dexterityequipmult.md) | number | Dexterity multiplier from equipment. | -| [equipment](./bitburner.gangmemberinfo.equipment.md) | [GangEquipment](./bitburner.gangequipment.md)\[\] | Array of names of all owned Non-Augmentation Equipment | +| [equipment](./bitburner.gangmemberinfo.equipment.md) | string\[\] | Array of names of all owned Non-Augmentation Equipment | | [hacking](./bitburner.gangmemberinfo.hacking.md) | number | Hacking stat | | [hackingAscensionMult](./bitburner.gangmemberinfo.hackingascensionmult.md) | number | Hacking multiplier from ascension. | | [hackingEquipMult](./bitburner.gangmemberinfo.hackingequipmult.md) | number | Hacking multiplier from equipment. | | [strength](./bitburner.gangmemberinfo.strength.md) | number | Strength stat | | [strengthAscensionMult](./bitburner.gangmemberinfo.strengthascensionmult.md) | number | Strength multiplier from ascension. | | [strengthEquipMult](./bitburner.gangmemberinfo.strengthequipmult.md) | number | Strength multiplier from equipment. | -| [task](./bitburner.gangmemberinfo.task.md) | [GangTasks](./bitburner.gangtasks.md) | Name of currently assigned task | +| [task](./bitburner.gangmemberinfo.task.md) | string | Name of currently assigned task | diff --git a/markdown/bitburner.gangmemberinfo.task.md b/markdown/bitburner.gangmemberinfo.task.md index 240642ebb..14e855454 100644 --- a/markdown/bitburner.gangmemberinfo.task.md +++ b/markdown/bitburner.gangmemberinfo.task.md @@ -9,5 +9,5 @@ Name of currently assigned task Signature: ```typescript -task: GangTasks; +task: string; ``` diff --git a/markdown/bitburner.gangname.md b/markdown/bitburner.gangname.md deleted file mode 100644 index 7a8d1913b..000000000 --- a/markdown/bitburner.gangname.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangName](./bitburner.gangname.md) - -## GangName type - -All factions that can have a gang. - -Signature: - -```typescript -type GangName = - | "Slum Snakes" - | "Tetrads" - | "The Syndicate" - | "The Dark Army" - | "Speakers for the Dead" - | "NiteSec" - | "The Black Hand"; -``` diff --git a/markdown/bitburner.gangotherinfo.md b/markdown/bitburner.gangotherinfo.md index cb4b554a8..287dd2924 100644 --- a/markdown/bitburner.gangotherinfo.md +++ b/markdown/bitburner.gangotherinfo.md @@ -9,9 +9,8 @@ ```typescript type GangOtherInfo = { - /** Stock Symbol */ - [key in GangName]: GangOtherInfoObject[]; + [key: string]: GangOtherInfoObject[]; }; ``` -References: [GangName](./bitburner.gangname.md), [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) +References: [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) diff --git a/markdown/bitburner.gangtasks.md b/markdown/bitburner.gangtasks.md deleted file mode 100644 index dff4db9b2..000000000 --- a/markdown/bitburner.gangtasks.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasks](./bitburner.gangtasks.md) - -## GangTasks type - -All Gang tasks. - -Signature: - -```typescript -type GangTasks = - | "Unassigned" - | "Ransomware" - | "Phishing" - | "Identity Theft" - | "DDoS Attacks" - | "Plant Virus" - | "Fraud & Counterfeiting" - | "Money Laundering" - | "Cyberterrorism" - | "Ethical Hacking" - | "Mug People" - | "Deal Drugs" - | "Strongarm Civilians" - | "Run a Con" - | "Armed Robbery" - | "Traffick Illegal Arms" - | "Threaten & Blackmail" - | "Human Trafficking" - | "Terrorism" - | "Vigilante Justice" - | "Train Combat" - | "Train Hacking" - | "Train Charisma" - | "Territory Warfare"; -``` diff --git a/markdown/bitburner.gangtasksstats.agiweight.md b/markdown/bitburner.gangtasksstats.agiweight.md deleted file mode 100644 index 78d3d9372..000000000 --- a/markdown/bitburner.gangtasksstats.agiweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [agiWeight](./bitburner.gangtasksstats.agiweight.md) - -## GangTasksStats.agiWeight property - -Agility skill impact on task scaling - -Signature: - -```typescript -agiWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.basemoney.md b/markdown/bitburner.gangtasksstats.basemoney.md deleted file mode 100644 index ddec18ff4..000000000 --- a/markdown/bitburner.gangtasksstats.basemoney.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseMoney](./bitburner.gangtasksstats.basemoney.md) - -## GangTasksStats.baseMoney property - -Base money earned - -Signature: - -```typescript -baseMoney: number; -``` diff --git a/markdown/bitburner.gangtasksstats.baserespect.md b/markdown/bitburner.gangtasksstats.baserespect.md deleted file mode 100644 index 2cebf8a23..000000000 --- a/markdown/bitburner.gangtasksstats.baserespect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseRespect](./bitburner.gangtasksstats.baserespect.md) - -## GangTasksStats.baseRespect property - -Base respect earned - -Signature: - -```typescript -baseRespect: number; -``` diff --git a/markdown/bitburner.gangtasksstats.basewanted.md b/markdown/bitburner.gangtasksstats.basewanted.md deleted file mode 100644 index 635ff5755..000000000 --- a/markdown/bitburner.gangtasksstats.basewanted.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseWanted](./bitburner.gangtasksstats.basewanted.md) - -## GangTasksStats.baseWanted property - -Base wanted earned - -Signature: - -```typescript -baseWanted: number; -``` diff --git a/markdown/bitburner.gangtasksstats.chaweight.md b/markdown/bitburner.gangtasksstats.chaweight.md deleted file mode 100644 index c2ac795ff..000000000 --- a/markdown/bitburner.gangtasksstats.chaweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [chaWeight](./bitburner.gangtasksstats.chaweight.md) - -## GangTasksStats.chaWeight property - -Charisma skill impact on task scaling - -Signature: - -```typescript -chaWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.defweight.md b/markdown/bitburner.gangtasksstats.defweight.md deleted file mode 100644 index 67299a579..000000000 --- a/markdown/bitburner.gangtasksstats.defweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [defWeight](./bitburner.gangtasksstats.defweight.md) - -## GangTasksStats.defWeight property - -Defense skill impact on task scaling - -Signature: - -```typescript -defWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.desc.md b/markdown/bitburner.gangtasksstats.desc.md deleted file mode 100644 index eff5d3490..000000000 --- a/markdown/bitburner.gangtasksstats.desc.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [desc](./bitburner.gangtasksstats.desc.md) - -## GangTasksStats.desc property - -Task Description - -Signature: - -```typescript -desc: string; -``` diff --git a/markdown/bitburner.gangtasksstats.dexweight.md b/markdown/bitburner.gangtasksstats.dexweight.md deleted file mode 100644 index d3a5d8cdf..000000000 --- a/markdown/bitburner.gangtasksstats.dexweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [dexWeight](./bitburner.gangtasksstats.dexweight.md) - -## GangTasksStats.dexWeight property - -Dexterity skill impact on task scaling - -Signature: - -```typescript -dexWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.difficulty.md b/markdown/bitburner.gangtasksstats.difficulty.md deleted file mode 100644 index ad17933b1..000000000 --- a/markdown/bitburner.gangtasksstats.difficulty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [difficulty](./bitburner.gangtasksstats.difficulty.md) - -## GangTasksStats.difficulty property - -Number representing the difficulty of the task - -Signature: - -```typescript -difficulty: number; -``` diff --git a/markdown/bitburner.gangtasksstats.hackweight.md b/markdown/bitburner.gangtasksstats.hackweight.md deleted file mode 100644 index fec445565..000000000 --- a/markdown/bitburner.gangtasksstats.hackweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [hackWeight](./bitburner.gangtasksstats.hackweight.md) - -## GangTasksStats.hackWeight property - -Hacking skill impact on task scaling - -Signature: - -```typescript -hackWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.iscombat.md b/markdown/bitburner.gangtasksstats.iscombat.md deleted file mode 100644 index f1c4d610b..000000000 --- a/markdown/bitburner.gangtasksstats.iscombat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [isCombat](./bitburner.gangtasksstats.iscombat.md) - -## GangTasksStats.isCombat property - -Is a task of a combat gang - -Signature: - -```typescript -isCombat: boolean; -``` diff --git a/markdown/bitburner.gangtasksstats.ishacking.md b/markdown/bitburner.gangtasksstats.ishacking.md deleted file mode 100644 index 1f0f615c8..000000000 --- a/markdown/bitburner.gangtasksstats.ishacking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [isHacking](./bitburner.gangtasksstats.ishacking.md) - -## GangTasksStats.isHacking property - -Is a task of a hacking gang - -Signature: - -```typescript -isHacking: boolean; -``` diff --git a/markdown/bitburner.gangtasksstats.md b/markdown/bitburner.gangtasksstats.md deleted file mode 100644 index fafa93c39..000000000 --- a/markdown/bitburner.gangtasksstats.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) - -## GangTasksStats interface - -Object representing data representing a gang member task. - -Signature: - -```typescript -interface GangTasksStats -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [agiWeight](./bitburner.gangtasksstats.agiweight.md) | number | Agility skill impact on task scaling | -| [baseMoney](./bitburner.gangtasksstats.basemoney.md) | number | Base money earned | -| [baseRespect](./bitburner.gangtasksstats.baserespect.md) | number | Base respect earned | -| [baseWanted](./bitburner.gangtasksstats.basewanted.md) | number | Base wanted earned | -| [chaWeight](./bitburner.gangtasksstats.chaweight.md) | number | Charisma skill impact on task scaling | -| [defWeight](./bitburner.gangtasksstats.defweight.md) | number | Defense skill impact on task scaling | -| [desc](./bitburner.gangtasksstats.desc.md) | string | Task Description | -| [dexWeight](./bitburner.gangtasksstats.dexweight.md) | number | Dexterity skill impact on task scaling | -| [difficulty](./bitburner.gangtasksstats.difficulty.md) | number | Number representing the difficulty of the task | -| [hackWeight](./bitburner.gangtasksstats.hackweight.md) | number | Hacking skill impact on task scaling | -| [isCombat](./bitburner.gangtasksstats.iscombat.md) | boolean | Is a task of a combat gang | -| [isHacking](./bitburner.gangtasksstats.ishacking.md) | boolean | Is a task of a hacking gang | -| [name](./bitburner.gangtasksstats.name.md) | [GangTasks](./bitburner.gangtasks.md) | Task name | -| [strWeight](./bitburner.gangtasksstats.strweight.md) | number | Stength skill impact on task scaling | -| [territory](./bitburner.gangtasksstats.territory.md) | [GangTasksTerritory](./bitburner.gangtasksterritory.md) | Territory impact on task scaling | - diff --git a/markdown/bitburner.gangtasksstats.name.md b/markdown/bitburner.gangtasksstats.name.md deleted file mode 100644 index bb6287ba2..000000000 --- a/markdown/bitburner.gangtasksstats.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [name](./bitburner.gangtasksstats.name.md) - -## GangTasksStats.name property - -Task name - -Signature: - -```typescript -name: GangTasks; -``` diff --git a/markdown/bitburner.gangtasksstats.strweight.md b/markdown/bitburner.gangtasksstats.strweight.md deleted file mode 100644 index 49be07da6..000000000 --- a/markdown/bitburner.gangtasksstats.strweight.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [strWeight](./bitburner.gangtasksstats.strweight.md) - -## GangTasksStats.strWeight property - -Stength skill impact on task scaling - -Signature: - -```typescript -strWeight: number; -``` diff --git a/markdown/bitburner.gangtasksstats.territory.md b/markdown/bitburner.gangtasksstats.territory.md deleted file mode 100644 index 0d4ec5ae3..000000000 --- a/markdown/bitburner.gangtasksstats.territory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [territory](./bitburner.gangtasksstats.territory.md) - -## GangTasksStats.territory property - -Territory impact on task scaling - -Signature: - -```typescript -territory: GangTasksTerritory; -``` diff --git a/markdown/bitburner.gangtasksterritory.md b/markdown/bitburner.gangtasksterritory.md deleted file mode 100644 index 042c68d35..000000000 --- a/markdown/bitburner.gangtasksterritory.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) - -## GangTasksTerritory interface - - -Signature: - -```typescript -interface GangTasksTerritory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [money](./bitburner.gangtasksterritory.money.md) | number | Money gain impact on task scaling | -| [respect](./bitburner.gangtasksterritory.respect.md) | number | Respect gain impact on task scaling | -| [wanted](./bitburner.gangtasksterritory.wanted.md) | number | Wanted gain impact on task scaling | - diff --git a/markdown/bitburner.gangtasksterritory.money.md b/markdown/bitburner.gangtasksterritory.money.md deleted file mode 100644 index 8fe1175e7..000000000 --- a/markdown/bitburner.gangtasksterritory.money.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [money](./bitburner.gangtasksterritory.money.md) - -## GangTasksTerritory.money property - -Money gain impact on task scaling - -Signature: - -```typescript -money: number; -``` diff --git a/markdown/bitburner.gangtasksterritory.respect.md b/markdown/bitburner.gangtasksterritory.respect.md deleted file mode 100644 index 8d5c77e47..000000000 --- a/markdown/bitburner.gangtasksterritory.respect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [respect](./bitburner.gangtasksterritory.respect.md) - -## GangTasksTerritory.respect property - -Respect gain impact on task scaling - -Signature: - -```typescript -respect: number; -``` diff --git a/markdown/bitburner.gangtasksterritory.wanted.md b/markdown/bitburner.gangtasksterritory.wanted.md deleted file mode 100644 index 05f776eeb..000000000 --- a/markdown/bitburner.gangtasksterritory.wanted.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [wanted](./bitburner.gangtasksterritory.wanted.md) - -## GangTasksTerritory.wanted property - -Wanted gain impact on task scaling - -Signature: - -```typescript -wanted: number; -``` diff --git a/markdown/bitburner.gym.md b/markdown/bitburner.gym.md deleted file mode 100644 index a0ff01e93..000000000 --- a/markdown/bitburner.gym.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Gym](./bitburner.gym.md) - -## Gym type - -All gyms. - -Signature: - -```typescript -type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; -``` diff --git a/markdown/bitburner.gymstat.md b/markdown/bitburner.gymstat.md deleted file mode 100644 index 31cf0503c..000000000 --- a/markdown/bitburner.gymstat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GymStat](./bitburner.gymstat.md) - -## GymStat type - -All stats that can be trained at gyms. - -Signature: - -```typescript -type GymStat = "str" | "def" | "dex" | "agi"; -``` diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md index aa4fbd8dc..6a9d5055c 100644 --- a/markdown/bitburner.hacknet.getcacheupgradecost.md +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -4,11 +4,7 @@ ## Hacknet.getCacheUpgradeCost() method -This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - -Returns the cost of upgrading the cache level of the specified Hacknet Server by n. - -If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. +Calculate the cost of upgrading hacknet node cache. Signature: @@ -33,3 +29,9 @@ Cost of upgrading the specified Hacknet Node's cache. 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. + diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md index 2fb78c962..47447d33c 100644 --- a/markdown/bitburner.hacknet.getcoreupgradecost.md +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -4,9 +4,7 @@ ## Hacknet.getCoreUpgradeCost() method -Returns the cost of upgrading the number of cores of the specified Hacknet Node by n. - -If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. +Calculate the cost of upgrading hacknet node cores. Signature: @@ -31,3 +29,7 @@ Cost of upgrading the specified Hacknet Node's number of cores. 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. + diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md index ca79577d3..13f8d07fa 100644 --- a/markdown/bitburner.hacknet.getlevelupgradecost.md +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -4,9 +4,7 @@ ## Hacknet.getLevelUpgradeCost() method -Returns the cost of upgrading the specified Hacknet Node by n levels. - -If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. +Calculate the cost of upgrading hacknet node levels. Signature: @@ -31,3 +29,7 @@ Cost of upgrading the specified Hacknet Node. 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. + diff --git a/markdown/bitburner.hacknet.getnodestats.md b/markdown/bitburner.hacknet.getnodestats.md index 480c09715..117d9d41c 100644 --- a/markdown/bitburner.hacknet.getnodestats.md +++ b/markdown/bitburner.hacknet.getnodestats.md @@ -4,9 +4,7 @@ ## Hacknet.getNodeStats() method -Returns an object containing a variety of stats about the specified Hacknet Node. - -Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates. +Get the stats of a hacknet node. Signature: @@ -30,3 +28,7 @@ Object containing a variety of stats about the specified Hacknet Node. 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. + diff --git a/markdown/bitburner.hacknet.getpurchasenodecost.md b/markdown/bitburner.hacknet.getpurchasenodecost.md index 1a4d040a2..a1d1908d1 100644 --- a/markdown/bitburner.hacknet.getpurchasenodecost.md +++ b/markdown/bitburner.hacknet.getpurchasenodecost.md @@ -4,7 +4,7 @@ ## Hacknet.getPurchaseNodeCost() method -Returns the cost of purchasing a new Hacknet Node. +Get the price of the next hacknet node. Signature: @@ -21,3 +21,5 @@ Cost of purchasing a new Hacknet Node. RAM cost: 0 GB +Returns the cost of purchasing a new Hacknet Node. + diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md index e806e3d6a..7ff433a1a 100644 --- a/markdown/bitburner.hacknet.getramupgradecost.md +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -4,9 +4,7 @@ ## Hacknet.getRamUpgradeCost() method -Returns the cost of upgrading the RAM of the specified Hacknet Node n times. - -If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. +Calculate the cost of upgrading hacknet node RAM. Signature: @@ -31,3 +29,7 @@ Cost of upgrading the specified Hacknet Node's ram. 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 is already at max level, then Infinity is returned. + diff --git a/markdown/bitburner.hacknet.hashcost.md b/markdown/bitburner.hacknet.hashcost.md index ff7652cb4..276b853df 100644 --- a/markdown/bitburner.hacknet.hashcost.md +++ b/markdown/bitburner.hacknet.hashcost.md @@ -4,21 +4,19 @@ ## Hacknet.hashCost() method -This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - -Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. +Get the cost of a hash upgrade. Signature: ```typescript -hashCost(upgName: HashUpgrades): number; +hashCost(upgName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| upgName | [HashUpgrades](./bitburner.hashupgrades.md) | Name of the upgrade of Hacknet Node. | +| upgName | string | Name of the upgrade of Hacknet Node. | Returns: @@ -30,6 +28,10 @@ Number of hashes required for the specified upgrade. 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 diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md index a40d0ff00..f42379c4a 100644 --- a/markdown/bitburner.hacknet.md +++ b/markdown/bitburner.hacknet.md @@ -12,23 +12,27 @@ Hacknet API interface Hacknet ``` +## Remarks + +Not all these functions are immediately available. + ## Methods | Method | Description | | --- | --- | -| [getCacheUpgradeCost(index, n)](./bitburner.hacknet.getcacheupgradecost.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the cost of upgrading the cache level of the specified Hacknet Server by n.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | -| [getCoreUpgradeCost(index, n)](./bitburner.hacknet.getcoreupgradecost.md) | Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | -| [getLevelUpgradeCost(index, n)](./bitburner.hacknet.getlevelupgradecost.md) | Returns the cost of upgrading the specified Hacknet Node by n levels.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | -| [getNodeStats(index)](./bitburner.hacknet.getnodestats.md) | Returns an object containing a variety of stats about the specified Hacknet Node.Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates. | -| [getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) | Returns the cost of purchasing a new Hacknet Node. | -| [getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) | Returns the cost of upgrading the RAM of the specified Hacknet Node n times.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | -| [hashCost(upgName)](./bitburner.hacknet.hashcost.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. | -| [numHashes()](./bitburner.hacknet.numhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the number of hashes you have. | -| [numNodes()](./bitburner.hacknet.numnodes.md) | Returns the number of Hacknet Nodes you own. | -| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named hacknet-node-4 will have an index of 4).If the player cannot afford to purchase a new Hacknet Node then the function will return -1. | -| [spendHashes(upgName, upgTarget)](./bitburner.hacknet.spendhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.The name of the upgrade must be an exact match. The upgTarget argument is used for upgrades such as Reduce Minimum Security, which applies to a specific server. In this case, the upgTarget argument must be the hostname of the server. | -| [upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Tries to upgrade the specified Hacknet Server’s cache n times.Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.Returns false otherwise. | -| [upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) | Tries to purchase n cores for the specified Hacknet Node.Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.Returns false otherwise. | -| [upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) | Tries to upgrade the level of the specified Hacknet Node by n.Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.Returns false otherwise. | -| [upgradeRam(index, n)](./bitburner.hacknet.upgraderam.md) | Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.Returns false otherwise. | +| [getCacheUpgradeCost(index, n)](./bitburner.hacknet.getcacheupgradecost.md) | Calculate the cost of upgrading hacknet node cache. | +| [getCoreUpgradeCost(index, n)](./bitburner.hacknet.getcoreupgradecost.md) | Calculate the cost of upgrading hacknet node cores. | +| [getLevelUpgradeCost(index, n)](./bitburner.hacknet.getlevelupgradecost.md) | Calculate the cost of upgrading hacknet node levels. | +| [getNodeStats(index)](./bitburner.hacknet.getnodestats.md) | Get the stats of a hacknet node. | +| [getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) | Get the price of the next hacknet node. | +| [getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) | Calculate the cost of upgrading hacknet node RAM. | +| [hashCost(upgName)](./bitburner.hacknet.hashcost.md) | Get the cost of a hash upgrade. | +| [numHashes()](./bitburner.hacknet.numhashes.md) | Get the total number of hashes stored. | +| [numNodes()](./bitburner.hacknet.numnodes.md) | Get the number of hacknet nodes you own. | +| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchase a new hacknet node. | +| [spendHashes(upgName, upgTarget)](./bitburner.hacknet.spendhashes.md) | Purchase a hash upgrade. | +| [upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) | Upgrade the cache of a hacknet node. | +| [upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) | Upgrade the core of a hacknet node. | +| [upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) | Upgrade the level of a hacknet node. | +| [upgradeRam(index, n)](./bitburner.hacknet.upgraderam.md) | Upgrade the RAM of a hacknet node. | diff --git a/markdown/bitburner.hacknet.numhashes.md b/markdown/bitburner.hacknet.numhashes.md index f51486187..9c20440b2 100644 --- a/markdown/bitburner.hacknet.numhashes.md +++ b/markdown/bitburner.hacknet.numhashes.md @@ -4,9 +4,7 @@ ## Hacknet.numHashes() method -This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - -Returns the number of hashes you have. +Get the total number of hashes stored. Signature: @@ -23,3 +21,7 @@ Number of hashes you have. 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. + diff --git a/markdown/bitburner.hacknet.numnodes.md b/markdown/bitburner.hacknet.numnodes.md index 3f6c6b97a..6144aeba5 100644 --- a/markdown/bitburner.hacknet.numnodes.md +++ b/markdown/bitburner.hacknet.numnodes.md @@ -4,7 +4,7 @@ ## Hacknet.numNodes() method -Returns the number of Hacknet Nodes you own. +Get the number of hacknet nodes you own. Signature: @@ -21,3 +21,5 @@ number of hacknet nodes. RAM cost: 0 GB +Returns the number of Hacknet Nodes you own. + diff --git a/markdown/bitburner.hacknet.purchasenode.md b/markdown/bitburner.hacknet.purchasenode.md index eace89021..762a8845e 100644 --- a/markdown/bitburner.hacknet.purchasenode.md +++ b/markdown/bitburner.hacknet.purchasenode.md @@ -4,9 +4,7 @@ ## Hacknet.purchaseNode() method -Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named `hacknet-node-4` will have an index of 4). - -If the player cannot afford to purchase a new Hacknet Node then the function will return -1. +Purchase a new hacknet node. Signature: @@ -23,3 +21,7 @@ The index of the Hacknet Node or if the player cannot afford to purchase a new H 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. + diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md index c495097b7..a3c18e1f7 100644 --- a/markdown/bitburner.hacknet.spendhashes.md +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -4,23 +4,19 @@ ## Hacknet.spendHashes() method -This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - -Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise. - -The name of the upgrade must be an exact match. The `upgTarget` argument is used for upgrades such as `Reduce Minimum Security`, which applies to a specific server. In this case, the `upgTarget` argument must be the hostname of the server. +Purchase a hash upgrade. Signature: ```typescript -spendHashes(upgName: HashUpgrades, upgTarget?: string): boolean; +spendHashes(upgName: string, upgTarget?: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| upgName | [HashUpgrades](./bitburner.hashupgrades.md) | Name of the upgrade of Hacknet Node. | +| upgName | string | Name of the upgrade of Hacknet Node. | | upgTarget | string | Object to which upgrade applies. Required for certain upgrades. | Returns: @@ -33,6 +29,12 @@ True if the upgrade is successfully purchased, and false otherwise.. 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 diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md index b0e1077ce..335d324f9 100644 --- a/markdown/bitburner.hacknet.upgradecache.md +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -4,13 +4,7 @@ ## Hacknet.upgradeCache() method -This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). - -Tries to upgrade the specified Hacknet Server’s cache n times. - -Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level. - -Returns false otherwise. +Upgrade the cache of a hacknet node. Signature: @@ -35,3 +29,11 @@ True if the Hacknet Node’s cores are successfully purchased, false otherwise. 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. + diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md index 8f0d3a75f..cab7fe4bb 100644 --- a/markdown/bitburner.hacknet.upgradecore.md +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -4,11 +4,7 @@ ## Hacknet.upgradeCore() method -Tries to purchase n cores for the specified Hacknet Node. - -Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores. - -Returns false otherwise. +Upgrade the core of a hacknet node. Signature: @@ -33,3 +29,9 @@ True if the Hacknet Node’s cores are successfully purchased, false otherwise. 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. + diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md index cdad67ae1..fa286db87 100644 --- a/markdown/bitburner.hacknet.upgradelevel.md +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -4,11 +4,7 @@ ## Hacknet.upgradeLevel() method -Tries to upgrade the level of the specified Hacknet Node by n. - -Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level. - -Returns false otherwise. +Upgrade the level of a hacknet node. Signature: @@ -33,3 +29,9 @@ True if the Hacknet Node’s level is successfully upgraded, false otherwise. 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. + diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md index 82f534478..9cc593219 100644 --- a/markdown/bitburner.hacknet.upgraderam.md +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -4,11 +4,7 @@ ## Hacknet.upgradeRam() method -Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n. - -Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM. - -Returns false otherwise. +Upgrade the RAM of a hacknet node. Signature: @@ -33,3 +29,9 @@ True if the Hacknet Node’s ram is successfully upgraded, false otherwise. 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 it max RAM. + +Returns false otherwise. + diff --git a/markdown/bitburner.hashupgrades.md b/markdown/bitburner.hashupgrades.md deleted file mode 100644 index 4d6e46685..000000000 --- a/markdown/bitburner.hashupgrades.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [HashUpgrades](./bitburner.hashupgrades.md) - -## HashUpgrades type - -All Hash upgrade names. - -Signature: - -```typescript -type HashUpgrades = - | "Sell for Money" - | "Sell for Corporation Funds" - | "Reduce Minimum Security" - | "Increase Maximum Money" - | "Improve Studying" - | "Improve Gym Training" - | "Exchange for Corporation Research" - | "Exchange for Bladeburner Rank" - | "Exchange for Bladeburner SP" - | "Generate Coding Contract"; -``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md index e1958b1e0..7473ad20f 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -12,7 +12,7 @@ | [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) | | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). | | [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. | -| [Bladeburner](./bitburner.bladeburner.md) | | +| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API | | [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. | | [CharacterInfo](./bitburner.characterinfo.md) | | | [CharacterMult](./bitburner.charactermult.md) | | @@ -20,13 +20,10 @@ | [CodingContract](./bitburner.codingcontract.md) | Coding Contact API | | [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. | | [Gang](./bitburner.gang.md) | Gang API | -| [GangEquipmentStats](./bitburner.gangequipmentstats.md) | Object representing data representing a gang member equipment. | | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. | | [GangMemberAscension](./bitburner.gangmemberascension.md) | | | [GangMemberInfo](./bitburner.gangmemberinfo.md) | | | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | -| [GangTasksStats](./bitburner.gangtasksstats.md) | Object representing data representing a gang member task. | -| [GangTasksTerritory](./bitburner.gangtasksterritory.md) | | | [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | | [Hacknet](./bitburner.hacknet.md) | Hacknet API | | [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. | @@ -43,42 +40,16 @@ | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | | | [SourceFileLvl](./bitburner.sourcefilelvl.md) | | | [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | +| [stringStats](./bitburner.stringstats.md) | Object representing data representing a gang member task. | +| [stringTerritory](./bitburner.stringterritory.md) | | | [TIX](./bitburner.tix.md) | Stock market API | ## Type Aliases | Type Alias | Description | | --- | --- | -| [AugmentName](./bitburner.augmentname.md) | All augmentation names. | -| [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | All Bladeburner action types. | -| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | All Bladeburner black ops. | -| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) | | -| [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) | All Bladeburner General Actions. | -| [BladeburnerOperations](./bitburner.bladeburneroperations.md) | All Bladeburner Ops. | -| [BladeburnerSkills](./bitburner.bladeburnerskills.md) | All Bladeburner Skills. | -| [City](./bitburner.city.md) | All cities. | -| [CodingContractTypes](./bitburner.codingcontracttypes.md) | All Coding contract types. | -| [CompanyField](./bitburner.companyfield.md) | All company work fields. | -| [CompanyName](./bitburner.companyname.md) | All companies. | -| [Crime](./bitburner.crime.md) | All crimes. | -| [FactionName](./bitburner.factionname.md) | All factions. | -| [FactionWork](./bitburner.factionwork.md) | All faction work types. | -| [GangAugmentations](./bitburner.gangaugmentations.md) | All Gang augmentations. | -| [GangEquipment](./bitburner.gangequipment.md) | All Gang equipment. | -| [GangEquipmentType](./bitburner.gangequipmenttype.md) | All Gang equipment type. | -| [GangName](./bitburner.gangname.md) | All factions that can have a gang. | | [GangOtherInfo](./bitburner.gangotherinfo.md) | | -| [GangTasks](./bitburner.gangtasks.md) | All Gang tasks. | -| [Gym](./bitburner.gym.md) | All gyms. | -| [GymStat](./bitburner.gymstat.md) | All stats that can be trained at gyms. | | [Handle](./bitburner.handle.md) | | -| [HashUpgrades](./bitburner.hashupgrades.md) | All Hash upgrade names. | -| [OrderPosition](./bitburner.orderposition.md) | All possible stock market order positions. | -| [OrderType](./bitburner.ordertype.md) | All possible stock market order type. | | [Port](./bitburner.port.md) | Queue used to send and receive messages. | -| [Programs](./bitburner.programs.md) | All programs. | | [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) | -| [StockSymbol](./bitburner.stocksymbol.md) | All possible stock market symbols. | -| [University](./bitburner.university.md) | All universities. | -| [UniversityCourse](./bitburner.universitycourse.md) | All university courses. | diff --git a/markdown/bitburner.ns.fileexists.md b/markdown/bitburner.ns.fileexists.md index 3a56d22e3..b91973a28 100644 --- a/markdown/bitburner.ns.fileexists.md +++ b/markdown/bitburner.ns.fileexists.md @@ -19,7 +19,7 @@ fileExists(filename: string, host?: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | filename | string | Filename of file to check. | -| host | string | Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. | +| 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. | Returns: diff --git a/markdown/bitburner.ns.getgrowtime.md b/markdown/bitburner.ns.getgrowtime.md index 49e227756..b2c2e2100 100644 --- a/markdown/bitburner.ns.getgrowtime.md +++ b/markdown/bitburner.ns.getgrowtime.md @@ -16,7 +16,7 @@ getGrowTime(host: string, hackLvl?: number, intLvl?: number): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | | hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | | intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | diff --git a/markdown/bitburner.ns.gethacktime.md b/markdown/bitburner.ns.gethacktime.md index cfce7e258..cfe1e832f 100644 --- a/markdown/bitburner.ns.gethacktime.md +++ b/markdown/bitburner.ns.gethacktime.md @@ -16,7 +16,7 @@ getHackTime(host: string, hackLvl?: number, intLvl?: number): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | | hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | | intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md index 432683bd0..8db67d75d 100644 --- a/markdown/bitburner.ns.getporthandle.md +++ b/markdown/bitburner.ns.getporthandle.md @@ -28,5 +28,5 @@ Data in the specified port. ## Remarks -10 GB +RAM cost: 10 GB diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md index 740cf59df..8cf60a1a2 100644 --- a/markdown/bitburner.ns.getscriptram.md +++ b/markdown/bitburner.ns.getscriptram.md @@ -17,7 +17,7 @@ getScriptRam(script: string, host?: string): number; | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script. This is case-sensitive. | -| host | string | Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. | +| host | string | Host of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. | Returns: diff --git a/markdown/bitburner.ns.getserverbasesecuritylevel.md b/markdown/bitburner.ns.getserverbasesecuritylevel.md index e354c2fec..9bfcb86a8 100644 --- a/markdown/bitburner.ns.getserverbasesecuritylevel.md +++ b/markdown/bitburner.ns.getserverbasesecuritylevel.md @@ -16,7 +16,7 @@ getServerBaseSecurityLevel(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getservergrowth.md b/markdown/bitburner.ns.getservergrowth.md index 0ade4821d..cd56164f2 100644 --- a/markdown/bitburner.ns.getservergrowth.md +++ b/markdown/bitburner.ns.getservergrowth.md @@ -16,7 +16,7 @@ getServerGrowth(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getservermaxmoney.md b/markdown/bitburner.ns.getservermaxmoney.md index f32c63d1a..5365d6ef1 100644 --- a/markdown/bitburner.ns.getservermaxmoney.md +++ b/markdown/bitburner.ns.getservermaxmoney.md @@ -16,7 +16,7 @@ getServerMaxMoney(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getserverminsecuritylevel.md b/markdown/bitburner.ns.getserverminsecuritylevel.md index 67d4af9c7..5cdf56e77 100644 --- a/markdown/bitburner.ns.getserverminsecuritylevel.md +++ b/markdown/bitburner.ns.getserverminsecuritylevel.md @@ -16,7 +16,7 @@ getServerMinSecurityLevel(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getservermoneyavailable.md b/markdown/bitburner.ns.getservermoneyavailable.md index bc50f1dfb..53d2b0aca 100644 --- a/markdown/bitburner.ns.getservermoneyavailable.md +++ b/markdown/bitburner.ns.getservermoneyavailable.md @@ -16,7 +16,7 @@ getServerMoneyAvailable(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server | +| host | string | Host of target server | Returns: diff --git a/markdown/bitburner.ns.getservernumportsrequired.md b/markdown/bitburner.ns.getservernumportsrequired.md index 702f19107..5237a9967 100644 --- a/markdown/bitburner.ns.getservernumportsrequired.md +++ b/markdown/bitburner.ns.getservernumportsrequired.md @@ -16,7 +16,7 @@ getServerNumPortsRequired(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getserverram.md b/markdown/bitburner.ns.getserverram.md index d8188d47d..ce8b68768 100644 --- a/markdown/bitburner.ns.getserverram.md +++ b/markdown/bitburner.ns.getserverram.md @@ -16,7 +16,7 @@ getServerRam(host: string): [number, number]; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getserverrequiredhackinglevel.md b/markdown/bitburner.ns.getserverrequiredhackinglevel.md index b9c9402ac..1816e21ba 100644 --- a/markdown/bitburner.ns.getserverrequiredhackinglevel.md +++ b/markdown/bitburner.ns.getserverrequiredhackinglevel.md @@ -16,7 +16,7 @@ getServerRequiredHackingLevel(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getserversecuritylevel.md b/markdown/bitburner.ns.getserversecuritylevel.md index a7835e956..26c2e3bf4 100644 --- a/markdown/bitburner.ns.getserversecuritylevel.md +++ b/markdown/bitburner.ns.getserversecuritylevel.md @@ -16,7 +16,7 @@ getServerSecurityLevel(host: string): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md index c6b80efdf..704cf3156 100644 --- a/markdown/bitburner.ns.getweakentime.md +++ b/markdown/bitburner.ns.getweakentime.md @@ -16,7 +16,7 @@ getWeakenTime(host: string, hackLvl?: number, intLvl?: number): number; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | | hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | | intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md index 80c48195e..dae3d6d51 100644 --- a/markdown/bitburner.ns.grow.md +++ b/markdown/bitburner.ns.grow.md @@ -4,9 +4,7 @@ ## NS.grow() method -Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When `grow` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate. - -Like hack, `grow` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. +Spoof money in a servers bank account, increasing the amount available. Signature: @@ -29,7 +27,9 @@ The number by which the money on the server was multiplied for the growth. ## Remarks -RAM cost: 0.15 GB +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 a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate. + +Like hack, `grow` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. ## Example diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md index fccea31f1..a90d5d872 100644 --- a/markdown/bitburner.ns.hack.md +++ b/markdown/bitburner.ns.hack.md @@ -4,11 +4,7 @@ ## NS.hack() method -Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level. - -A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game. - -A successful `hack()` on a server will raise that server’s security level by 0.002. +Steal a servers money. Signature: @@ -31,14 +27,17 @@ The amount of money stolen if the hack is successful, and zero otherwise. ## Remarks -RAM cost: 0.1 GB +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. 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 hack("foodnstuff"); -hack("10.1.2.3"); hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack ``` diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md index 5d869d35f..e01ea74b3 100644 --- a/markdown/bitburner.ns.hackanalyzethreads.md +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -4,9 +4,7 @@ ## NS.hackAnalyzeThreads() method -This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1. - -Warning: The value returned by this function isn’t necessarily a whole number. +Predict the effect of hack. Signature: @@ -29,7 +27,9 @@ The number of threads needed to hack the server for hackAmount money. ## Remarks -RAM cost: 1 GB +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 diff --git a/markdown/bitburner.ns.hacknet.md b/markdown/bitburner.ns.hacknet.md index 5992061aa..c8fa3a0d5 100644 --- a/markdown/bitburner.ns.hacknet.md +++ b/markdown/bitburner.ns.hacknet.md @@ -14,11 +14,5 @@ readonly hacknet: Hacknet; ## Remarks -Not all functions in the Hacknet Node API are immediately available. - -Note that none of these functions will write to the script’s logs. - -If you want to see what your script is doing you will have to print to the logs yourself. - -4 GB +RAM cost: 4 GB diff --git a/markdown/bitburner.ns.hasrootaccess.md b/markdown/bitburner.ns.hasrootaccess.md index e36dff002..a82c57787 100644 --- a/markdown/bitburner.ns.hasrootaccess.md +++ b/markdown/bitburner.ns.hasrootaccess.md @@ -16,7 +16,7 @@ hasRootAccess(host: string): boolean; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of the target server | +| host | string | Host of the target server | Returns: diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md index 8c7a0d0c1..130d5d340 100644 --- a/markdown/bitburner.ns.isrunning.md +++ b/markdown/bitburner.ns.isrunning.md @@ -17,7 +17,7 @@ isRunning(script: string, host: string, ...args: string[]): boolean; | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script to check. This is case-sensitive. | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | | args | string\[\] | Arguments to specify/identify which scripts to search for. | Returns: diff --git a/markdown/bitburner.ns.ls.md b/markdown/bitburner.ns.ls.md index a7fd197a4..26c4f7f6f 100644 --- a/markdown/bitburner.ns.ls.md +++ b/markdown/bitburner.ns.ls.md @@ -16,7 +16,7 @@ ls(host: string, grep?: string): string[]; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of the target server. | +| host | string | Host of the target server. | | grep | string | A substring to search for in the filename. | Returns: diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 3095f66c1..5d341a9b5 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -69,13 +69,13 @@ export interface NS extends Singularity | [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100). | | [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | | [getWeakenTime(host, hackLvl, intLvl)](./bitburner.ns.getweakentime.md) | Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. | -| [grow(host, opts)](./bitburner.ns.grow.md) | Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When grow completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.Like hack, grow can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. | +| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a servers bank account, increasing the amount available. | | [growthAnalyze(host, growthAmount)](./bitburner.ns.growthanalyze.md) | This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage.Warning: The value returned by this function isn’t necessarily a whole number. | | [growthAnalyzeSecurity(threads)](./bitburner.ns.growthanalyzesecurity.md) | Returns the security increase that would occur if a grow with this many threads happened. | -| [hack(host, opts)](./bitburner.ns.hack.md) | Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level.A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the foodnstuff server and run that script on any server in the game.A successful hack() on a server will raise that server’s security level by 0.002. | +| [hack(host, opts)](./bitburner.ns.hack.md) | Steal a servers money. | | [hackAnalyzePercent(host)](./bitburner.ns.hackanalyzepercent.md) | Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one). | | [hackAnalyzeSecurity(threads)](./bitburner.ns.hackanalyzesecurity.md) | Returns the security increase that would occur if a hack with this many threads happened. | -| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.Warning: The value returned by this function isn’t necessarily a whole number. | +| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | Predict the effect of hack. | | [hackChance(host)](./bitburner.ns.hackchance.md) | Returns the chance you have of successfully hacking the specified server.This returned value is in decimal form, not percentage. | | [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Returns a boolean indicating whether or not the player has root access to the specified target server. | | [httpworm(host)](./bitburner.ns.httpworm.md) | Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. | @@ -99,7 +99,7 @@ export interface NS extends Singularity | [scan(host, hostnames)](./bitburner.ns.scan.md) | Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings. | | [scp(files, destination)](./bitburner.ns.scp.md) | Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. | | [scp(files, source, destination)](./bitburner.ns.scp_1.md) | Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. | -| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments. | +| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kills all scripts with the specified filename on the target server specified by hostname, regardless of arguments. | | [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments. | | [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | | [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | @@ -110,8 +110,8 @@ export interface NS extends Singularity | [tprint(msg)](./bitburner.ns.tprint.md) | Prints a value or a variable to the Terminal. | | [tryWrite(port, data)](./bitburner.ns.trywrite.md) | Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally. | | [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Complete open source JavaScript sprintf implementation | -| [weaken(host, opts)](./bitburner.ns.weaken.md) | Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.Like hack and grow, weaken can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. | -| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Returns the security decrease that would occur if a weaken with this many threads happened. | +| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server security level. | +| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. | | [wget(url, target, host)](./bitburner.ns.wget.md) | Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS).IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0).In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0. | | [write(handle, data, mode)](./bitburner.ns.write.md) | This function can be used to either write data to a port or to a text file (.txt).If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port.If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file. | diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md index 12affa340..4ad335704 100644 --- a/markdown/bitburner.ns.ps.md +++ b/markdown/bitburner.ns.ps.md @@ -16,7 +16,7 @@ ps(host?: string): ProcessInfo[]; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP address of the target server. If not specified, it will be the current server’s IP by default. | +| host | string | Host address of the target server. If not specified, it will be the current server’s IP by default. | Returns: diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md index 7b5cb1a69..e1e881b37 100644 --- a/markdown/bitburner.ns.purchaseserver.md +++ b/markdown/bitburner.ns.purchaseserver.md @@ -15,7 +15,7 @@ Returns the hostname of the newly purchased server as a string. If the function Signature: ```typescript -purchaseServer(hostname: string, ram: number): string | ""; +purchaseServer(hostname: string, ram: number): string; ``` ## Parameters @@ -27,7 +27,7 @@ purchaseServer(hostname: string, ram: number): string | ""; Returns: -string \| "" +string The hostname of the newly purchased server. diff --git a/markdown/bitburner.ns.rm.md b/markdown/bitburner.ns.rm.md index 58eff9e5e..d5adf5131 100644 --- a/markdown/bitburner.ns.rm.md +++ b/markdown/bitburner.ns.rm.md @@ -17,7 +17,7 @@ rm(name: string, host?: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | name | string | Filename of file to remove. Must include the extension. | -| host | string | Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. | +| host | string | Host Address of the server on which to delete the file. Optional. Defaults to current server. | Returns: diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md index 1c44a9d14..1b430f434 100644 --- a/markdown/bitburner.ns.scp.md +++ b/markdown/bitburner.ns.scp.md @@ -9,15 +9,15 @@ Copies a script or literature (.lit) file(s) to another server. The files argume Signature: ```typescript -scp(files: string | ReadonlyArray, destination: string): boolean; +scp(files: string[], destination: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| files | string \| ReadonlyArray<string> | Filename or an array of filenames of script/literature files to copy. | -| destination | string | Host or IP of the destination server, which is the server to which the file will be copied. | +| files | string\[\] | Filename or an array of filenames of script/literature files to copy. | +| destination | string | Host of the destination server, which is the server to which the file will be copied. | Returns: diff --git a/markdown/bitburner.ns.scp_1.md b/markdown/bitburner.ns.scp_1.md index f6f8eecc4..3cd6a7677 100644 --- a/markdown/bitburner.ns.scp_1.md +++ b/markdown/bitburner.ns.scp_1.md @@ -10,7 +10,7 @@ Copies a script or literature (.lit) file(s) to another server. The files argume ```typescript scp( - files: string | ReadonlyArray, + files: string[], source: string, // tslint:disable-next-line:unified-signatures destination: string, @@ -21,9 +21,9 @@ scp( | Parameter | Type | Description | | --- | --- | --- | -| files | string \| ReadonlyArray<string> | Filename or an array of filenames of script/literature files to copy. | -| source | string | Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. | -| destination | string | Host or IP of the destination server, which is the server to which the file will be copied. | +| files | string\[\] | Filename or an array of filenames of script/literature files to copy. | +| source | string | Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. | +| destination | string | Host of the destination server, which is the server to which the file will be copied. | Returns: diff --git a/markdown/bitburner.ns.scriptkill.md b/markdown/bitburner.ns.scriptkill.md index ea4ccaec7..f55f3005a 100644 --- a/markdown/bitburner.ns.scriptkill.md +++ b/markdown/bitburner.ns.scriptkill.md @@ -4,7 +4,7 @@ ## NS.scriptKill() method -Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments. +Kills all scripts with the specified filename on the target server specified by hostname, regardless of arguments. Signature: @@ -17,7 +17,7 @@ scriptKill(script: string, host: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script to kill. This is case-sensitive. | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.scriptrunning.md b/markdown/bitburner.ns.scriptrunning.md index 84c404eaa..743899860 100644 --- a/markdown/bitburner.ns.scriptrunning.md +++ b/markdown/bitburner.ns.scriptrunning.md @@ -19,7 +19,7 @@ scriptRunning(script: string, host: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | script | string | Filename of script to check. This is case-sensitive. | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.serverexists.md b/markdown/bitburner.ns.serverexists.md index 552947c9e..b0f66a4bc 100644 --- a/markdown/bitburner.ns.serverexists.md +++ b/markdown/bitburner.ns.serverexists.md @@ -16,7 +16,7 @@ serverExists(host: string): boolean; | Parameter | Type | Description | | --- | --- | --- | -| host | string | Host or IP of target server. | +| host | string | Host of target server. | Returns: diff --git a/markdown/bitburner.ns.trywrite.md b/markdown/bitburner.ns.trywrite.md index e254a9420..40f41d98b 100644 --- a/markdown/bitburner.ns.trywrite.md +++ b/markdown/bitburner.ns.trywrite.md @@ -9,7 +9,7 @@ Attempts to write data to the specified Netscript Port. If the port is full, the Signature: ```typescript -tryWrite(port: Handle, data: string | string[] | number): boolean; +tryWrite(port: Handle, data: string[] | number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ tryWrite(port: Handle, data: string | string[] | number): boolean; | Parameter | Type | Description | | --- | --- | --- | | port | [Handle](./bitburner.handle.md) | Port or text file that will be written to. | -| data | string \| string\[\] \| number | Data to write. | +| data | string\[\] \| number | Data to write. | Returns: diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md index 3ba4e1bd4..5571b2aad 100644 --- a/markdown/bitburner.ns.weaken.md +++ b/markdown/bitburner.ns.weaken.md @@ -4,9 +4,7 @@ ## NS.weaken() method -Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05. - -Like hack and grow, `weaken` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. +Reduce a server security level. Signature: @@ -29,7 +27,9 @@ The amount by which the target server’s security level was decreased. This is ## Remarks -RAM cost: 0.15 GB +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 command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05. + +Like hack and grow, `weaken` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. ## Example diff --git a/markdown/bitburner.ns.weakenanalyze.md b/markdown/bitburner.ns.weakenanalyze.md index b5d58795e..c91cd87ff 100644 --- a/markdown/bitburner.ns.weakenanalyze.md +++ b/markdown/bitburner.ns.weakenanalyze.md @@ -4,7 +4,7 @@ ## NS.weakenAnalyze() method -Returns the security decrease that would occur if a weaken with this many threads happened. +Predict the effect of weaken. Signature: @@ -27,5 +27,5 @@ The security decrease. ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB Returns the security decrease that would occur if a weaken with this many threads happened. diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md index 5734a40d5..db9e1b23f 100644 --- a/markdown/bitburner.ns.write.md +++ b/markdown/bitburner.ns.write.md @@ -13,7 +13,7 @@ If the first argument is a string, then it specifies the name of a text file (.t Signature: ```typescript -write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; +write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void; ``` ## Parameters @@ -21,7 +21,7 @@ write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void | Parameter | Type | Description | | --- | --- | --- | | handle | [Handle](./bitburner.handle.md) | Port or text file that will be written to. | -| data | string \| string\[\] \| number | Data to write. | +| data | string\[\] \| number | Data to write. | | mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. | Returns: diff --git a/markdown/bitburner.orderposition.md b/markdown/bitburner.orderposition.md deleted file mode 100644 index 77b9dbc2c..000000000 --- a/markdown/bitburner.orderposition.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [OrderPosition](./bitburner.orderposition.md) - -## OrderPosition type - -All possible stock market order positions. - -Signature: - -```typescript -type OrderPosition = "long" | "short"; -``` diff --git a/markdown/bitburner.ordertype.md b/markdown/bitburner.ordertype.md deleted file mode 100644 index 5a552fbbd..000000000 --- a/markdown/bitburner.ordertype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [OrderType](./bitburner.ordertype.md) - -## OrderType type - -All possible stock market order type. - -Signature: - -```typescript -type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; -``` diff --git a/markdown/bitburner.port.md b/markdown/bitburner.port.md index a830a1da7..49ca7403f 100644 --- a/markdown/bitburner.port.md +++ b/markdown/bitburner.port.md @@ -9,7 +9,7 @@ Queue used to send and receive messages. Signature: ```typescript -type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; +type Port = number; ``` ## Remarks diff --git a/markdown/bitburner.programs.md b/markdown/bitburner.programs.md deleted file mode 100644 index dd974b0fe..000000000 --- a/markdown/bitburner.programs.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Programs](./bitburner.programs.md) - -## Programs type - -All programs. - -Signature: - -```typescript -type Programs = - | "autolink.exe" - | "brutessh.exe" - | "deepscanv1.exe" - | "deepscanv2.exe" - | "ftpcrack.exe" - | "httpworm.exe" - | "relaysmtp.exe" - | "serverprofiler.exe" - | "sqlinject.exe"; -``` diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md index bd76d5f83..328d7c8fa 100644 --- a/markdown/bitburner.singularity.applytocompany.md +++ b/markdown/bitburner.singularity.applytocompany.md @@ -4,24 +4,20 @@ ## Singularity.applyToCompany() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at. - -This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false. +Apply for a job at a company. Signature: ```typescript -applyToCompany(companyName: CompanyName, field: CompanyField): boolean; +applyToCompany(companyName: string, field: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to apply to. | -| field | [CompanyField](./bitburner.companyfield.md) | Field to which you want to apply. | +| companyName | string | Name of company to apply to. | +| field | string | Field to which you want to apply. | Returns: @@ -31,5 +27,11 @@ True if the player successfully get a job/promotion, and false otherwise. ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +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. + diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md index 8b90062fb..167d4234d 100644 --- a/markdown/bitburner.singularity.checkfactioninvitations.md +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -4,22 +4,24 @@ ## Singularity.checkFactionInvitations() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns an array with the name of all Factions you currently have oustanding invitations from. +List all current faction invitations. Signature: ```typescript -checkFactionInvitations(): FactionName[]; +checkFactionInvitations(): string[]; ``` Returns: -[FactionName](./bitburner.factionname.md)\[\] +string\[\] Array with the name of all Factions you currently have oustanding invitations from. ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +Returns an array with the name of all Factions you currently have oustanding invitations from. + diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md index 6ea625de5..3682f3e52 100644 --- a/markdown/bitburner.singularity.commitcrime.md +++ b/markdown/bitburner.singularity.commitcrime.md @@ -4,25 +4,19 @@ ## Singularity.commitCrime() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. - -This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60). - -Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. +Commit a crime. Signature: ```typescript -commitCrime(crime: Crime): number; +commitCrime(crime: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [Crime](./bitburner.crime.md) | Name of crime to attempt. | +| crime | string | Name of crime to attempt. | Returns: @@ -32,5 +26,13 @@ True if you successfully start working on the specified program, and false other ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. + +This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60). + +Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. + diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md index 6ec456b92..ae7c62069 100644 --- a/markdown/bitburner.singularity.createprogram.md +++ b/markdown/bitburner.singularity.createprogram.md @@ -4,25 +4,19 @@ ## Singularity.createProgram() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings. - -This function returns true if you successfully start working on the specified program, and false otherwise. - -Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: \* BruteSSH.exe: 50 \* FTPCrack.exe: 100 \* relaySMTP.exe: 250 \* HTTPWorm.exe: 500 \* SQLInject.exe: 750 \* DeepscanV1.exe: 75 \* DeepscanV2.exe: 400 \* ServerProfiler.exe: 75 \* AutoLink.exe: 25 +Create a program. Signature: ```typescript -createProgram(program: Programs): boolean; +createProgram(program: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| program | [Programs](./bitburner.programs.md) | Name of program to create. | +| program | string | Name of program to create. | Returns: @@ -32,8 +26,16 @@ True if you successfully start working on the specified program, and false other ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +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 diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md index a17f2e9b9..aaa8c4525 100644 --- a/markdown/bitburner.singularity.donatetofaction.md +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -4,21 +4,19 @@ ## Singularity.donateToFaction() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. +Donate to a faction. Signature: ```typescript -donateToFaction(faction: FactionName, amount: number): boolean; +donateToFaction(faction: string, amount: number): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to donate to. | +| faction | string | Name of faction to donate to. | | amount | number | Amount of money to donate. | Returns: @@ -29,5 +27,9 @@ True if the money was donated, and false otherwise. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. + diff --git a/markdown/bitburner.singularity.getaugmentationcost.md b/markdown/bitburner.singularity.getaugmentationcost.md deleted file mode 100644 index 2bd16fd5d..000000000 --- a/markdown/bitburner.singularity.getaugmentationcost.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationCost](./bitburner.singularity.getaugmentationcost.md) - -## Singularity.getAugmentationCost() method - -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost. - -If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\]. - -Signature: - -```typescript -getAugmentationCost(augName: AugmentName): [number, number]; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| augName | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. | - -Returns: - -\[number, number\] - -Array with first element as a reputation requirement and second element as the money cost. - -## Remarks - -Singularity - Level 3 - diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md index 452977235..f094fa787 100644 --- a/markdown/bitburner.singularity.getaugmentationprereq.md +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -4,29 +4,31 @@ ## Singularity.getAugmentationPrereq() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. +Get the pre-requisite of an augmentation. Signature: ```typescript -getAugmentationPrereq(augName: AugmentName): AugmentName[]; +getAugmentationPrereq(augName: string): string[]; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| augName | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. | +| augName | string | Name of Augmentation. | Returns: -[AugmentName](./bitburner.augmentname.md)\[\] +string\[\] Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +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. + diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md index bd0f8cb52..1e1aa29e2 100644 --- a/markdown/bitburner.singularity.getaugmentationsfromfaction.md +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -4,29 +4,31 @@ ## Singularity.getAugmentationsFromFaction() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. +Get a list of augmentation available from a faction. Signature: ```typescript -getAugmentationsFromFaction(faction: FactionName): AugmentName[]; +getAugmentationsFromFaction(faction: string): string[]; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | +| faction | string | Name of faction. | Returns: -[AugmentName](./bitburner.augmentname.md)\[\] +string\[\] Array containing the names of all Augmentations. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. + diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md index 00ed40bde..ac1157338 100644 --- a/markdown/bitburner.singularity.getaugmentationstats.md +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -4,21 +4,19 @@ ## Singularity.getAugmentationStats() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns augmentation stats. +Get the stats of an augmentation. Signature: ```typescript -getAugmentationStats(name: AugmentName): AugmentationStats; +getAugmentationStats(name: string): AugmentationStats; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. CASE-SENSITIVE. | +| name | string | Name of Augmentation. CASE-SENSITIVE. | Returns: @@ -28,5 +26,9 @@ Augmentation stats. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function returns augmentation stats. + diff --git a/markdown/bitburner.singularity.getcharacterinformation.md b/markdown/bitburner.singularity.getcharacterinformation.md deleted file mode 100644 index 4db50e095..000000000 --- a/markdown/bitburner.singularity.getcharacterinformation.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCharacterInformation](./bitburner.singularity.getcharacterinformation.md) - -## Singularity.getCharacterInformation() method - -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns an object with various information about your character. - -Signature: - -```typescript -getCharacterInformation(): CharacterInfo; -``` -Returns: - -[CharacterInfo](./bitburner.characterinfo.md) - -Object with various information about your character. - -## Remarks - -Singularity - Level 1 - diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md index 1042a7c70..7a9ec9bba 100644 --- a/markdown/bitburner.singularity.getcompanyfavor.md +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -4,21 +4,19 @@ ## Singularity.getCompanyFavor() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. +Get company favor. Signature: ```typescript -getCompanyFavor(companyName: CompanyName): number; +getCompanyFavor(companyName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | +| companyName | string | Name of the company. | Returns: @@ -28,5 +26,9 @@ Amount of favor you have at the specified company. ## Remarks +RAM cost: 1 GB + Singularity - Level 2 +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. + diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md index 6bb62e87a..fb1f84b46 100644 --- a/markdown/bitburner.singularity.getcompanyfavorgain.md +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -4,21 +4,19 @@ ## Singularity.getCompanyFavorGain() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. +Get company favor gain. Signature: ```typescript -getCompanyFavorGain(companyName: CompanyName): number; +getCompanyFavorGain(companyName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | +| companyName | string | Name of the company. | Returns: @@ -28,5 +26,9 @@ Amount of favor you gain at the specified company when you reset by installing A ## Remarks +RAM cost: 0.75 GB + Singularity - Level 2 +This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. + diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md index 4579e9d61..ce93db0ba 100644 --- a/markdown/bitburner.singularity.getcompanyrep.md +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -4,21 +4,19 @@ ## Singularity.getCompanyRep() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. +Get company reputation. Signature: ```typescript -getCompanyRep(companyName: CompanyName): number; +getCompanyRep(companyName: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | +| companyName | string | Name of the company. | Returns: @@ -28,5 +26,9 @@ Amount of reputation you have at the specified company. ## Remarks +RAM cost: 1 GB + Singularity - Level 2 +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. + diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index 663ddaca7..9423e649a 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -4,29 +4,31 @@ ## Singularity.getCrimeChance() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6). +Get chance to successfully commit a crime. Signature: ```typescript -getCrimeChance(crime: Crime): number; +getCrimeChance(crime: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [Crime](./bitburner.crime.md) | Name of crime. | +| crime | string | Name of crime. | Returns: number -Chance of success at commiting the specified crime as a decimal. +Chance of success at commiting the specified crime. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function returns your chance of success at commiting the specified crime. + diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md index 25ca921f2..4e53d4630 100644 --- a/markdown/bitburner.singularity.getcrimestats.md +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -4,21 +4,19 @@ ## Singularity.getCrimeStats() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns the stats of the crime. +Get stats related to a crime. Signature: ```typescript -getCrimeStats(crime: Crime): CrimeStats; +getCrimeStats(crime: string): CrimeStats; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [Crime](./bitburner.crime.md) | Name of crime. Not case-sensitive | +| crime | string | Name of crime. Not case-sensitive | Returns: @@ -28,5 +26,9 @@ The stats of the crime. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +Returns the stats of the crime. + diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md index 25a637523..fb2820d93 100644 --- a/markdown/bitburner.singularity.getfactionfavor.md +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -4,21 +4,19 @@ ## Singularity.getFactionFavor() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns the amount of favor you have for the specified faction. +Get faction favor. Signature: ```typescript -getFactionFavor(faction: FactionName): number; +getFactionFavor(faction: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | +| faction | string | Name of faction. | Returns: @@ -28,5 +26,9 @@ Amount of favor you have for the specified faction. ## Remarks +RAM cost: 1 GB + Singularity - Level 2 +This function returns the amount of favor you have for the specified faction. + diff --git a/markdown/bitburner.singularity.getfactionfavorgain.md b/markdown/bitburner.singularity.getfactionfavorgain.md index 01ee148d2..9e7e44405 100644 --- a/markdown/bitburner.singularity.getfactionfavorgain.md +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -4,21 +4,19 @@ ## Singularity.getFactionFavorGain() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. +Get faction favor gain. Signature: ```typescript -getFactionFavorGain(faction: FactionName): number; +getFactionFavorGain(faction: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | +| faction | string | Name of faction. | Returns: @@ -28,5 +26,9 @@ Amount of favor you will gain for the specified faction when you reset by instal ## Remarks +RAM cost: 0.75 GB + Singularity - Level 2 +This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. + diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md index 2638fcd15..f5229f9a4 100644 --- a/markdown/bitburner.singularity.getfactionrep.md +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -4,21 +4,19 @@ ## Singularity.getFactionRep() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns the amount of reputation you have for the specified faction. +Get faction reputation. Signature: ```typescript -getFactionRep(faction: FactionName): number; +getFactionRep(faction: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | +| faction | string | Name of faction to work for. | Returns: @@ -28,5 +26,9 @@ Amount of reputation you have for the specified faction. ## Remarks +RAM cost: 1 GB + Singularity - Level 2 +This function returns the amount of reputation you have for the specified faction. + diff --git a/markdown/bitburner.singularity.getownedaugmentations.md b/markdown/bitburner.singularity.getownedaugmentations.md index 0411b145b..14ce96db6 100644 --- a/markdown/bitburner.singularity.getownedaugmentations.md +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -4,14 +4,12 @@ ## Singularity.getOwnedAugmentations() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function returns an array containing the names (as strings) of all Augmentations you have. +Get a list of owned augmentation. Signature: ```typescript -getOwnedAugmentations(purchased?: boolean): AugmentName[]; +getOwnedAugmentations(purchased?: boolean): string[]; ``` ## Parameters @@ -22,11 +20,15 @@ getOwnedAugmentations(purchased?: boolean): AugmentName[]; Returns: -[AugmentName](./bitburner.augmentname.md)\[\] +string\[\] Array containing the names (as strings) of all Augmentations you have. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function returns an array containing the names (as strings) of all Augmentations you have. + diff --git a/markdown/bitburner.singularity.getownedsourcefiles.md b/markdown/bitburner.singularity.getownedsourcefiles.md index 1c2f9b63b..545a9dcaa 100644 --- a/markdown/bitburner.singularity.getownedsourcefiles.md +++ b/markdown/bitburner.singularity.getownedsourcefiles.md @@ -4,9 +4,7 @@ ## Singularity.getOwnedSourceFiles() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns an array of source files +Get a list of acquired Source-Files. Signature: @@ -21,5 +19,9 @@ Array containing an object with number and level of the source file. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +Returns an array of source files + diff --git a/markdown/bitburner.singularity.getstats.md b/markdown/bitburner.singularity.getstats.md deleted file mode 100644 index 8eecf3428..000000000 --- a/markdown/bitburner.singularity.getstats.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getStats](./bitburner.singularity.getstats.md) - -## Singularity.getStats() method - -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns an object with the Player’s stats. - -Signature: - -```typescript -getStats(): PlayerSkills; -``` -Returns: - -[PlayerSkills](./bitburner.playerskills.md) - -Object with the Player’s stats. - -## Remarks - -Singularity - Level 1 - -## Example - - -```ts -res = getStats(); -print('My charisma level is: ' + res.charisma); -``` - diff --git a/markdown/bitburner.singularity.getupgradehomeramcost.md b/markdown/bitburner.singularity.getupgradehomeramcost.md index 03db70c93..b831c4b53 100644 --- a/markdown/bitburner.singularity.getupgradehomeramcost.md +++ b/markdown/bitburner.singularity.getupgradehomeramcost.md @@ -4,9 +4,7 @@ ## Singularity.getUpgradeHomeRamCost() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns the cost of upgrading the player’s home computer RAM. +Get the price of upgrading home RAM. Signature: @@ -21,5 +19,9 @@ Cost of upgrading the player’s home computer RAM. ## Remarks +RAM cost: 1.5 GB + Singularity - Level 2 +Returns the cost of upgrading the player’s home computer RAM. + diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md index 6e9b035aa..f666bb724 100644 --- a/markdown/bitburner.singularity.gymworkout.md +++ b/markdown/bitburner.singularity.gymworkout.md @@ -4,24 +4,20 @@ ## Singularity.gymWorkout() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. - -The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train +Workout at the gym. Signature: ```typescript -gymWorkout(gymName: Gym, stat: GymStat): boolean; +gymWorkout(gymName: string, stat: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| gymName | [Gym](./bitburner.gym.md) | Name of gym. You must be in the correct city for whatever gym you specify. | -| stat | [GymStat](./bitburner.gymstat.md) | The stat you want to train. | +| 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. | Returns: @@ -31,5 +27,11 @@ True if actions is successfully started, false otherwise. ## Remarks +RAM cost: 2 GB + Singularity - Level 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 + diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md index 7f6a92f72..e8fcd8577 100644 --- a/markdown/bitburner.singularity.installaugmentations.md +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -4,9 +4,7 @@ ## Singularity.installAugmentations() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically install your Augmentations, resetting the game as usual. +Install your purchased augmentations. Signature: @@ -18,7 +16,7 @@ installAugmentations(cbScript?: string): void; | Parameter | Type | Description | | --- | --- | --- | -| cbScript | string | Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. | +| 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: @@ -26,5 +24,9 @@ void ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function will automatically install your Augmentations, resetting the game as usual. + diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md index 0a573a4d8..018280421 100644 --- a/markdown/bitburner.singularity.isbusy.md +++ b/markdown/bitburner.singularity.isbusy.md @@ -4,9 +4,7 @@ ## Singularity.isBusy() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. +Check if the player is busy. Signature: @@ -21,5 +19,9 @@ True if the player is currently performing an ‘action’, false otherwise. ## Remarks +RAM cost: 0.5 GB + Singularity - Level 1 +Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. + diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md index 27290583c..833f145df 100644 --- a/markdown/bitburner.singularity.joinfaction.md +++ b/markdown/bitburner.singularity.joinfaction.md @@ -4,21 +4,19 @@ ## Singularity.joinFaction() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically accept an invitation from a faction and join it. +Join a faction. Signature: ```typescript -joinFaction(faction: FactionName): boolean; +joinFaction(faction: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to join. | +| faction | string | Name of faction to join. | Returns: @@ -28,5 +26,9 @@ True if player joined the faction, and false otherwise. ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +This function will automatically accept an invitation from a faction and join it. + diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index ba4dfe144..2a82ab897 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -12,44 +12,45 @@ Singularity API interface Singularity ``` +## Remarks + +This API requires Source-File 4 level 1 / 2 / 3 to use. + ## Methods | Method | Description | | --- | --- | -| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false. | -| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array with the name of all Factions you currently have oustanding invitations from. | -| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running commitCrime('rob store') will return 60).Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. | -| [createProgram(program)](./bitburner.singularity.createprogram.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.This function returns true if you successfully start working on the specified program, and false otherwise.Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: \* BruteSSH.exe: 50 \* FTPCrack.exe: 100 \* relaySMTP.exe: 250 \* HTTPWorm.exe: 500 \* SQLInject.exe: 750 \* DeepscanV1.exe: 75 \* DeepscanV2.exe: 400 \* ServerProfiler.exe: 75 \* AutoLink.exe: 25 | -| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. | -| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\]. | -| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. | -| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. | -| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns augmentation stats. | -| [getCharacterInformation()](./bitburner.singularity.getcharacterinformation.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an object with various information about your character. | -| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. | -| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. | -| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. | -| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6). | -| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns the stats of the crime. | -| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of favor you have for the specified faction. | -| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. | -| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of reputation you have for the specified faction. | -| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array containing the names (as strings) of all Augmentations you have. | -| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array of source files | -| [getStats()](./bitburner.singularity.getstats.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an object with the Player’s stats. | -| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns the cost of upgrading the player’s home computer RAM. | -| [gymWorkout(gymName, stat)](./bitburner.singularity.gymworkout.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train | -| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically install your Augmentations, resetting the game as usual. | -| [isBusy()](./bitburner.singularity.isbusy.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. | -| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically accept an invitation from a faction and join it. | -| [purchaseAugmentation(faction, augmnet)](./bitburner.singularity.purchaseaugmentation.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will try to purchase the specified Augmentation through the given Faction.This function will return true if the Augmentation is successfully purchased, and false otherwise. | -| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. | -| [purchaseTor()](./bitburner.singularity.purchasetor.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. | -| [softReset()](./bitburner.singularity.softreset.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will perform a reset even if you don’t have any augmentation installed. | -| [stopAction()](./bitburner.singularity.stopaction.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.The actions that can be stopped with this function are:\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a CrimeThis function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. | -| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. | -| [universityCourse(universityName, courseName)](./bitburner.singularity.universitycourse.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes. | -| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. | -| [workForCompany(companyName)](./bitburner.singularity.workforcompany.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.This function will return true if the player starts working, and false otherwise.Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. | -| [workForFaction(faction, workType)](./bitburner.singularity.workforfaction.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.This function will return true if you successfully start working for the specified faction, and false otherwise.Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. | +| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | +| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | +| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | Commit a crime. | +| [createProgram(program)](./bitburner.singularity.createprogram.md) | Create a program. | +| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. | +| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. | +| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | Get a list of augmentation available from a faction. | +| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | Get the stats of an augmentation. | +| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | Get company favor. | +| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | Get company favor gain. | +| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | Get company reputation. | +| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. | +| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. | +| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | +| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | +| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | +| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | Get a list of owned augmentation. | +| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | Get a list of acquired Source-Files. | +| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. | +| [gymWorkout(gymName, stat)](./bitburner.singularity.gymworkout.md) | Workout at the gym. | +| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | Install your purchased augmentations. | +| [isBusy()](./bitburner.singularity.isbusy.md) | Check if the player is busy. | +| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | Join a faction. | +| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation | +| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. | +| [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. | +| [softReset()](./bitburner.singularity.softreset.md) | Soft reset the game. | +| [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. | +| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | Travel to another city. | +| [universityCourse(universityName, courseName)](./bitburner.singularity.universitycourse.md) | Take university class. | +| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | Upgrade home computer RAM. | +| [workForCompany(companyName)](./bitburner.singularity.workforcompany.md) | Work for a company. | +| [workForFaction(faction, workType)](./bitburner.singularity.workforfaction.md) | Work for a faction. | diff --git a/markdown/bitburner.singularity.purchaseaugmentation.md b/markdown/bitburner.singularity.purchaseaugmentation.md index cad2629e0..2156870dd 100644 --- a/markdown/bitburner.singularity.purchaseaugmentation.md +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -4,24 +4,20 @@ ## Singularity.purchaseAugmentation() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will try to purchase the specified Augmentation through the given Faction. - -This function will return true if the Augmentation is successfully purchased, and false otherwise. +Purchase an augmentation Signature: ```typescript -purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; +purchaseAugmentation(faction: string, augmentation: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to purchase Augmentation from. | -| augmnet | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation to purchase. | +| faction | string | Name of faction to purchase Augmentation from. | +| augmentation | string | Name of Augmentation to purchase. | Returns: @@ -31,5 +27,11 @@ True if the Augmentation is successfully purchased, and false otherwise. ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +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. + diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md index a16378cfc..b71b87f2d 100644 --- a/markdown/bitburner.singularity.purchaseprogram.md +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -4,21 +4,19 @@ ## Singularity.purchaseProgram() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. +Purchase a program from the dark web. Signature: ```typescript -purchaseProgram(programName: Programs): boolean; +purchaseProgram(programName: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| programName | [Programs](./bitburner.programs.md) | Name of program to purchase. | +| programName | string | Name of program to purchase. | Returns: @@ -28,8 +26,12 @@ True if the specified program is purchased, and false otherwise. ## Remarks +RAM cost: 2 GB + Singularity - Level 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 diff --git a/markdown/bitburner.singularity.purchasetor.md b/markdown/bitburner.singularity.purchasetor.md index e8a81cd6f..35918c534 100644 --- a/markdown/bitburner.singularity.purchasetor.md +++ b/markdown/bitburner.singularity.purchasetor.md @@ -4,9 +4,7 @@ ## Singularity.purchaseTor() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. +Purchase the TOR router. Signature: @@ -21,5 +19,9 @@ True if actions is successful, false otherwise. ## Remarks +RAM cost: 2 GB + Singularity - Level 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. + diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md index be5388387..9879a8034 100644 --- a/markdown/bitburner.singularity.softreset.md +++ b/markdown/bitburner.singularity.softreset.md @@ -4,9 +4,7 @@ ## Singularity.softReset() method -If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will perform a reset even if you don’t have any augmentation installed. +Soft reset the game. Signature: @@ -19,5 +17,9 @@ void ## Remarks +RAM cost: 5 GB + Singularity - Level 3 +This function will perform a reset even if you don’t have any augmentation installed. + diff --git a/markdown/bitburner.singularity.stopaction.md b/markdown/bitburner.singularity.stopaction.md index 78fa90716..d63a3edc2 100644 --- a/markdown/bitburner.singularity.stopaction.md +++ b/markdown/bitburner.singularity.stopaction.md @@ -4,15 +4,7 @@ ## Singularity.stopAction() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action. - -The actions that can be stopped with this function are: - -\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a Crime - -This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. +Stop the current action. Signature: @@ -27,5 +19,15 @@ True if the player’s action was ended, false if the player was not performing ## Remarks +RAM cost: 1 GB + Singularity - Level 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 for a company/faction \* Creating a program \* Committing a Crime + +This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. + diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md index 5178da68a..2543bb1d5 100644 --- a/markdown/bitburner.singularity.traveltocity.md +++ b/markdown/bitburner.singularity.traveltocity.md @@ -4,21 +4,19 @@ ## Singularity.travelToCity() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. +Travel to another city. Signature: ```typescript -travelToCity(city: City): boolean; +travelToCity(city: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [City](./bitburner.city.md) | City to travel to. | +| city | string | City to travel to. | Returns: @@ -28,5 +26,9 @@ True if actions is successful, false otherwise. ## Remarks +RAM cost: 2 GB + Singularity - Level 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. + diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md index 0c0110c77..a07ce8a34 100644 --- a/markdown/bitburner.singularity.universitycourse.md +++ b/markdown/bitburner.singularity.universitycourse.md @@ -4,24 +4,20 @@ ## Singularity.universityCourse() method -If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. - -The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes. +Take university class. Signature: ```typescript -universityCourse(universityName: University, courseName: UniversityCourse): boolean; +universityCourse(universityName: string, courseName: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| universityName | [University](./bitburner.university.md) | Name of university. You must be in the correct city for whatever university you specify. | -| courseName | [UniversityCourse](./bitburner.universitycourse.md) | Name of course. | +| universityName | string | Name of university. You must be in the correct city for whatever university you specify. | +| courseName | string | Name of course. | Returns: @@ -31,5 +27,11 @@ True if actions is successfully started, false otherwise. ## Remarks +RAM cost: 2 GB + Singularity - Level 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. + diff --git a/markdown/bitburner.singularity.upgradehomeram.md b/markdown/bitburner.singularity.upgradehomeram.md index 7a79e6b55..a53cdf1ad 100644 --- a/markdown/bitburner.singularity.upgradehomeram.md +++ b/markdown/bitburner.singularity.upgradehomeram.md @@ -4,11 +4,7 @@ ## Singularity.upgradeHomeRam() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually. - -This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. +Upgrade home computer RAM. Signature: @@ -23,5 +19,11 @@ True if the player’s home computer RAM is successfully upgraded, and false oth ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +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. + diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md index fa398e997..b11db74ea 100644 --- a/markdown/bitburner.singularity.workforcompany.md +++ b/markdown/bitburner.singularity.workforcompany.md @@ -4,25 +4,19 @@ ## Singularity.workForCompany() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. - -This function will return true if the player starts working, and false otherwise. - -Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. +Work for a company. Signature: ```typescript -workForCompany(companyName?: CompanyName): boolean; +workForCompany(companyName?: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked | +| 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 | Returns: @@ -32,8 +26,16 @@ True if the player starts working, and false otherwise. ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if the player starts working, and false otherwise. + +Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. + ## Example diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md index e218b15d6..75e619cca 100644 --- a/markdown/bitburner.singularity.workforfaction.md +++ b/markdown/bitburner.singularity.workforfaction.md @@ -4,26 +4,20 @@ ## Singularity.workForFaction() method -If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. - -This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. - -This function will return true if you successfully start working for the specified faction, and false otherwise. - -Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. +Work for a faction. Signature: ```typescript -workForFaction(faction: FactionName, workType: FactionWork): boolean; +workForFaction(faction: string, workType: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | -| workType | [FactionWork](./bitburner.factionwork.md) | Type of work to perform for the faction. | +| faction | string | Name of faction to work for. | +| workType | string | Type of work to perform for the faction. | Returns: @@ -33,8 +27,16 @@ True if the player starts working, and false otherwise. ## Remarks +RAM cost: 3 GB + Singularity - Level 2 +This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if you successfully start working for the specified faction, and false otherwise. + +Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. + ## Example diff --git a/markdown/bitburner.sleeve.getinformation.md b/markdown/bitburner.sleeve.getinformation.md index 865896683..d36a20f73 100644 --- a/markdown/bitburner.sleeve.getinformation.md +++ b/markdown/bitburner.sleeve.getinformation.md @@ -4,9 +4,7 @@ ## Sleeve.getInformation() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a struct containing tons of information about this sleeve +Get information about a sleeve. Signature: @@ -30,3 +28,5 @@ Object containing tons of information about this sleeve. RAM cost: 4 GB +Return a struct containing tons of information about this sleeve + diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md index c1d28df74..e456fed41 100644 --- a/markdown/bitburner.sleeve.getnumsleeves.md +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -4,9 +4,7 @@ ## Sleeve.getNumSleeves() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return the number of duplicate sleeves the player has. +Get the number of sleeves you own. Signature: @@ -23,3 +21,5 @@ number of duplicate sleeves the player has. RAM cost: 4 GB +Return the number of duplicate sleeves the player has. + diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md index cd1caf5f5..d3835eac0 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentations.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -4,14 +4,12 @@ ## Sleeve.getSleeveAugmentations() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a list of augmentation names that this sleeve has installed. +Get augmentations installed on a sleeve. Signature: ```typescript -getSleeveAugmentations(sleeveNumber: number): AugmentName[]; +getSleeveAugmentations(sleeveNumber: number): string[]; ``` ## Parameters @@ -22,7 +20,7 @@ getSleeveAugmentations(sleeveNumber: number): AugmentName[]; Returns: -[AugmentName](./bitburner.augmentname.md)\[\] +string\[\] List of augmentation names that this sleeve has installed. @@ -30,3 +28,5 @@ List of augmentation names that this sleeve has installed. RAM cost: 4 GB +Return a list of augmentation names that this sleeve has installed. + diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md index ac0d26f66..b4c635a4f 100644 --- a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -4,9 +4,7 @@ ## Sleeve.getSleevePurchasableAugs() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a list of augmentations that the player can buy for this sleeve. +List purchasable augs for a sleeve. Signature: @@ -30,3 +28,5 @@ List of augmentations that the player can buy for this sleeve. RAM cost: 4 GB +Return a list of augmentations that the player can buy for this sleeve. + diff --git a/markdown/bitburner.sleeve.getsleevestats.md b/markdown/bitburner.sleeve.getsleevestats.md index c236b66d2..26fc5b68d 100644 --- a/markdown/bitburner.sleeve.getsleevestats.md +++ b/markdown/bitburner.sleeve.getsleevestats.md @@ -4,9 +4,7 @@ ## Sleeve.getSleeveStats() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a structure containing the stats of the sleeve. +Get the stats of a sleeve. Signature: @@ -30,3 +28,5 @@ Object containing the stats of the sleeve. RAM cost: 4 GB +Return a structure containing the stats of the sleeve. + diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md index e60bfd8f5..b9c08fb1d 100644 --- a/markdown/bitburner.sleeve.gettask.md +++ b/markdown/bitburner.sleeve.gettask.md @@ -4,9 +4,7 @@ ## Sleeve.getTask() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. +Get task of a sleeve. Signature: @@ -30,3 +28,5 @@ Object containing information the current task that the sleeve is performing. RAM cost: 4 GB +Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. + diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index fed90aff7..cdb2ddeec 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -12,23 +12,27 @@ Sleeve API interface Sleeve ``` +## Remarks + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. + ## Methods | Method | Description | | --- | --- | -| [getInformation(sleeveNumber)](./bitburner.sleeve.getinformation.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a struct containing tons of information about this sleeve | -| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the number of duplicate sleeves the player has. | -| [getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentation names that this sleeve has installed. | -| [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentations that the player can buy for this sleeve. | -| [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a structure containing the stats of the sleeve. | -| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. | -| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return true if the aug was purchased and installed on the sleeve. | -| [setToCommitCrime(sleeveNumber, name)](./bitburner.sleeve.settocommitcrime.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.Returns false if an invalid action is specified. | -| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this company. | -| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this faction. | -| [setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working out. | -| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | -| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | -| [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | -| [travel(sleeveNumber, cityName)](./bitburner.sleeve.travel.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve reached destination. | +| [getInformation(sleeveNumber)](./bitburner.sleeve.getinformation.md) | Get information about a sleeve. | +| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | Get the number of sleeves you own. | +| [getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) | Get augmentations installed on a sleeve. | +| [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | List purchasable augs for a sleeve. | +| [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | Get the stats of a sleeve. | +| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. | +| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. | +| [setToCommitCrime(sleeveNumber, name)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. | +| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. | +| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. | +| [setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) | Set a sleeve to workout at the gym. | +| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | Set a sleeve to shock recovery. | +| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | Set a sleeve to synchronize. | +| [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. | +| [travel(sleeveNumber, cityName)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. | diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md index bac267bf4..16d6f836a 100644 --- a/markdown/bitburner.sleeve.purchasesleeveaug.md +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -4,14 +4,12 @@ ## Sleeve.purchaseSleeveAug() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return true if the aug was purchased and installed on the sleeve. +Purchase an aug for a sleeve. Signature: ```typescript -purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; +purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; ``` ## Parameters @@ -19,7 +17,7 @@ purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to buy an aug for. | -| augName | [AugmentName](./bitburner.augmentname.md) | Name of the aug to buy. Must be an exact match. | +| augName | string | Name of the aug to buy. Must be an exact match. | Returns: @@ -31,3 +29,5 @@ True if the aug was purchased and installed on the sleeve, false otherwise. RAM cost: 4 GB +Return true if the aug was purchased and installed on the sleeve. + diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index e74501ff9..107c111ab 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -4,16 +4,12 @@ ## Sleeve.setToCommitCrime() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not this action was set successfully. - -Returns false if an invalid action is specified. +Set a sleeve to commit crime. Signature: ```typescript -setToCommitCrime(sleeveNumber: number, name: Crime): boolean; +setToCommitCrime(sleeveNumber: number, name: string): boolean; ``` ## Parameters @@ -21,7 +17,7 @@ setToCommitCrime(sleeveNumber: number, name: Crime): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start commiting crime. | -| name | [Crime](./bitburner.crime.md) | Name of the crime. Must be an exact match. | +| name | string | Name of the crime. Must be an exact match. | Returns: @@ -33,3 +29,7 @@ True if this action was set successfully, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not this action was set successfully. + +Returns false if an invalid action is specified. + diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index 07b75375d..bc8d93a0d 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -4,14 +4,12 @@ ## Sleeve.setToCompanyWork() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not the sleeve started working or this company. +Set a sleeve to work for a company. Signature: ```typescript -setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; +setToCompanyWork(sleeveNumber: number, companyName: string): boolean; ``` ## Parameters @@ -19,7 +17,7 @@ setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to work for the company. | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company to work for. | +| companyName | string | Name of the company to work for. | Returns: @@ -31,3 +29,5 @@ True if the sleeve started working on this company, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not the sleeve started working or this company. + diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index c8fa9b5fa..d1b0843f2 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -4,14 +4,12 @@ ## Sleeve.setToFactionWork() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not the sleeve started working or this faction. +Set a sleeve to work for a faction. Signature: ```typescript -setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; +setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: string): boolean; ``` ## Parameters @@ -19,8 +17,8 @@ setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to work for the faction. | -| factionName | [FactionName](./bitburner.factionname.md) | Name of the faction to work for. | -| factionWorkType | [FactionWork](./bitburner.factionwork.md) | Name of the action to perform for this faction. | +| factionName | string | Name of the faction to work for. | +| factionWorkType | string | Name of the action to perform for this faction. | Returns: @@ -32,3 +30,5 @@ True if the sleeve started working on this faction, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not the sleeve started working or this faction. + diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md index f863c5dca..b092838eb 100644 --- a/markdown/bitburner.sleeve.settogymworkout.md +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -4,14 +4,12 @@ ## Sleeve.setToGymWorkout() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not the sleeve started working out. +Set a sleeve to workout at the gym. Signature: ```typescript -setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; +setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; ``` ## Parameters @@ -19,8 +17,8 @@ setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to workout at the gym. | -| gymName | [Gym](./bitburner.gym.md) | Name of the gym. | -| stat | [GymStat](./bitburner.gymstat.md) | Name of the stat to train. | +| gymName | string | Name of the gym. | +| stat | string | Name of the stat to train. | Returns: @@ -32,3 +30,5 @@ True if the sleeve started working out, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not the sleeve started working out. + diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md index 96fe8cea6..93a1ef01c 100644 --- a/markdown/bitburner.sleeve.settoshockrecovery.md +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -4,9 +4,7 @@ ## Sleeve.setToShockRecovery() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not this action was set successfully. +Set a sleeve to shock recovery. Signature: @@ -30,3 +28,5 @@ True if this action was set successfully, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md index 54bd55fce..17fa4ca6d 100644 --- a/markdown/bitburner.sleeve.settosynchronize.md +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -4,9 +4,7 @@ ## Sleeve.setToSynchronize() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not this action was set successfully. +Set a sleeve to synchronize. Signature: @@ -30,3 +28,5 @@ True if this action was set successfully, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md index c37994a11..f96d60a8b 100644 --- a/markdown/bitburner.sleeve.settouniversitycourse.md +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -4,14 +4,12 @@ ## Sleeve.setToUniversityCourse() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not this action was set successfully. +Set a sleeve to take a class at a university. Signature: ```typescript -setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; +setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean; ``` ## Parameters @@ -19,8 +17,8 @@ setToUniversityCourse(sleeveNumber: number, university: University, className: U | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start taking class. | -| university | [University](./bitburner.university.md) | Name of the university to attend. | -| className | [UniversityCourse](./bitburner.universitycourse.md) | Name of the class to follow. | +| university | string | Name of the university to attend. | +| className | string | Name of the class to follow. | Returns: @@ -32,3 +30,5 @@ True if this action was set successfully, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index 284df1182..e3d98cbfa 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -4,14 +4,12 @@ ## Sleeve.travel() method -If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. - -Return a boolean indicating whether or not the sleeve reached destination. +Make a sleeve travel to another city. Signature: ```typescript -travel(sleeveNumber: number, cityName: City): boolean; +travel(sleeveNumber: number, cityName: string): boolean; ``` ## Parameters @@ -19,7 +17,7 @@ travel(sleeveNumber: number, cityName: City): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to travel. | -| cityName | [City](./bitburner.city.md) | Name of the destination city. | +| cityName | string | Name of the destination city. | Returns: @@ -31,3 +29,5 @@ True if the sleeve reached destination, false otherwise. RAM cost: 4 GB +Return a boolean indicating whether or not the sleeve reached destination. + diff --git a/markdown/bitburner.sleeveinformation.city.md b/markdown/bitburner.sleeveinformation.city.md index 4fecd52db..b408421ac 100644 --- a/markdown/bitburner.sleeveinformation.city.md +++ b/markdown/bitburner.sleeveinformation.city.md @@ -9,5 +9,5 @@ location of the sleeve Signature: ```typescript -city: City; +city: string; ``` diff --git a/markdown/bitburner.sleeveinformation.jobtitle.md b/markdown/bitburner.sleeveinformation.jobtitle.md index d97fdfc77..4801588ab 100644 --- a/markdown/bitburner.sleeveinformation.jobtitle.md +++ b/markdown/bitburner.sleeveinformation.jobtitle.md @@ -9,5 +9,5 @@ job titles available to the sleeve Signature: ```typescript -jobTitle: CompanyField[]; +jobTitle: string[]; ``` diff --git a/markdown/bitburner.sleeveinformation.md b/markdown/bitburner.sleeveinformation.md index 78e23a58b..0317e5ee2 100644 --- a/markdown/bitburner.sleeveinformation.md +++ b/markdown/bitburner.sleeveinformation.md @@ -16,13 +16,13 @@ interface SleeveInformation | Property | Type | Description | | --- | --- | --- | -| [city](./bitburner.sleeveinformation.city.md) | [City](./bitburner.city.md) | location of the sleeve | +| [city](./bitburner.sleeveinformation.city.md) | string | location of the sleeve | | [earningsForPlayer](./bitburner.sleeveinformation.earningsforplayer.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings synchronized to the player | | [earningsForSleeves](./bitburner.sleeveinformation.earningsforsleeves.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings synchronized to other sleeves | | [earningsForTask](./bitburner.sleeveinformation.earningsfortask.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings for this sleeve | | [hp](./bitburner.sleeveinformation.hp.md) | number | current hp of the sleeve | | [jobs](./bitburner.sleeveinformation.jobs.md) | string\[\] | jobs available to the sleeve | -| [jobTitle](./bitburner.sleeveinformation.jobtitle.md) | [CompanyField](./bitburner.companyfield.md)\[\] | job titles available to the sleeve | +| [jobTitle](./bitburner.sleeveinformation.jobtitle.md) | string\[\] | job titles available to the sleeve | | [maxHp](./bitburner.sleeveinformation.maxhp.md) | number | max hp of the sleeve | | [mult](./bitburner.sleeveinformation.mult.md) | [CharacterMult](./bitburner.charactermult.md) | sleeve multipliers | | [timeWorked](./bitburner.sleeveinformation.timeworked.md) | number | time spent on the current task in milliseconds | diff --git a/markdown/bitburner.sleevetask.crime.md b/markdown/bitburner.sleevetask.crime.md index e5ed9ce17..f45249f04 100644 --- a/markdown/bitburner.sleevetask.crime.md +++ b/markdown/bitburner.sleevetask.crime.md @@ -9,5 +9,5 @@ crime currently attempting, if any Signature: ```typescript -crime: Crime | ""; +crime: string; ``` diff --git a/markdown/bitburner.sleevetask.factionworktype.md b/markdown/bitburner.sleevetask.factionworktype.md index e643e96a3..8bac74d0a 100644 --- a/markdown/bitburner.sleevetask.factionworktype.md +++ b/markdown/bitburner.sleevetask.factionworktype.md @@ -9,5 +9,5 @@ faction work type being performed, if any Signature: ```typescript -factionWorkType: FactionWork | ""; +factionWorkType: string; ``` diff --git a/markdown/bitburner.sleevetask.gymstattype.md b/markdown/bitburner.sleevetask.gymstattype.md index c7fb7612f..ce3888da2 100644 --- a/markdown/bitburner.sleevetask.gymstattype.md +++ b/markdown/bitburner.sleevetask.gymstattype.md @@ -9,5 +9,5 @@ stat being trained at the gym, if any Signature: ```typescript -gymStatType: GymStat | ""; +gymStatType: string; ``` diff --git a/markdown/bitburner.sleevetask.location.md b/markdown/bitburner.sleevetask.location.md index 6aa91a33a..0238f9ef6 100644 --- a/markdown/bitburner.sleevetask.location.md +++ b/markdown/bitburner.sleevetask.location.md @@ -9,5 +9,5 @@ location of the task, if any Signature: ```typescript -location: City | ""; +location: string; ``` diff --git a/markdown/bitburner.sleevetask.md b/markdown/bitburner.sleevetask.md index 8aa0d0b2f..b1e5d6662 100644 --- a/markdown/bitburner.sleevetask.md +++ b/markdown/bitburner.sleevetask.md @@ -16,9 +16,9 @@ interface SleeveTask | Property | Type | Description | | --- | --- | --- | -| [crime](./bitburner.sleevetask.crime.md) | [Crime](./bitburner.crime.md) \| "" | crime currently attempting, if any | -| [factionWorkType](./bitburner.sleevetask.factionworktype.md) | [FactionWork](./bitburner.factionwork.md) \| "" | faction work type being performed, if any | -| [gymStatType](./bitburner.sleevetask.gymstattype.md) | [GymStat](./bitburner.gymstat.md) \| "" | stat being trained at the gym, if any | -| [location](./bitburner.sleevetask.location.md) | [City](./bitburner.city.md) \| "" | location of the task, if any | +| [crime](./bitburner.sleevetask.crime.md) | string | crime currently attempting, if any | +| [factionWorkType](./bitburner.sleevetask.factionworktype.md) | string | faction work type being performed, if any | +| [gymStatType](./bitburner.sleevetask.gymstattype.md) | string | stat being trained at the gym, if any | +| [location](./bitburner.sleevetask.location.md) | string | location of the task, if any | | [task](./bitburner.sleevetask.task.md) | string | task type | diff --git a/markdown/bitburner.sourcefilelvl.md b/markdown/bitburner.sourcefilelvl.md index df0a1b51d..ca986ed8b 100644 --- a/markdown/bitburner.sourcefilelvl.md +++ b/markdown/bitburner.sourcefilelvl.md @@ -16,5 +16,5 @@ interface SourceFileLvl | Property | Type | Description | | --- | --- | --- | | [lvl](./bitburner.sourcefilelvl.lvl.md) | number | The level of the source file | -| [n](./bitburner.sourcefilelvl.n.md) | 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 | The number of the source file | +| [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 c42971a0b..46ffb9ed9 100644 --- a/markdown/bitburner.sourcefilelvl.n.md +++ b/markdown/bitburner.sourcefilelvl.n.md @@ -9,5 +9,5 @@ The number of the source file Signature: ```typescript -n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; +n: number; ``` diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md index 342243d33..78b510677 100644 --- a/markdown/bitburner.stockorder.md +++ b/markdown/bitburner.stockorder.md @@ -10,9 +10,8 @@ Return value of [getOrders](./bitburner.tix.getorders.md) ```typescript type StockOrder = { - /** Stock Symbol */ - [key in StockSymbol]?: StockOrderObject[]; + [key: string]: StockOrderObject[]; }; ``` -References: [StockSymbol](./bitburner.stocksymbol.md), [StockOrderObject](./bitburner.stockorderobject.md) +References: [StockOrderObject](./bitburner.stockorderobject.md) diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md index bfda0ff83..b99bb76b1 100644 --- a/markdown/bitburner.stockorderobject.md +++ b/markdown/bitburner.stockorderobject.md @@ -16,8 +16,8 @@ interface StockOrderObject | Property | Type | Description | | --- | --- | --- | -| [position](./bitburner.stockorderobject.position.md) | "S" \| "L" | Order position | +| [position](./bitburner.stockorderobject.position.md) | string | Order position | | [price](./bitburner.stockorderobject.price.md) | number | Price per share | | [shares](./bitburner.stockorderobject.shares.md) | number | Number of shares | -| [type](./bitburner.stockorderobject.type.md) | "Limit Buy Order" \| "Limit Sell Order" \| "Stop Buy Order" \| "Stop Buy Order" | Order type | +| [type](./bitburner.stockorderobject.type.md) | string | Order type | diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md index 0f10d9d39..719917039 100644 --- a/markdown/bitburner.stockorderobject.position.md +++ b/markdown/bitburner.stockorderobject.position.md @@ -9,5 +9,5 @@ Order position Signature: ```typescript -position: "S" | "L"; +position: string; ``` diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md index e7acd7490..f5ce9fa29 100644 --- a/markdown/bitburner.stockorderobject.type.md +++ b/markdown/bitburner.stockorderobject.type.md @@ -9,5 +9,5 @@ Order type Signature: ```typescript -type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; +type: string; ``` diff --git a/markdown/bitburner.stocksymbol.md b/markdown/bitburner.stocksymbol.md deleted file mode 100644 index 815b7a780..000000000 --- a/markdown/bitburner.stocksymbol.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [StockSymbol](./bitburner.stocksymbol.md) - -## StockSymbol type - -All possible stock market symbols. - -Signature: - -```typescript -type StockSymbol = - | "ECP" - | "MGCP" - | "BLD" - | "CLRK" - | "OMTK" - | "FSIG" - | "KGI" - | "FLCM" - | "STM" - | "DCOMM" - | "HLS" - | "VITA" - | "ICRS" - | "UNV" - | "AERO" - | "OMN" - | "SLRS" - | "GPH" - | "NVMD" - | "WDS" - | "LXO" - | "RHOC" - | "APHE" - | "SYSC" - | "CTK" - | "NTLK" - | "OMGA" - | "FNS" - | "SGC" - | "JGN" - | "CTYS" - | "MDYN" - | "TITN"; -``` diff --git a/markdown/bitburner.stringstats.agi.md b/markdown/bitburner.stringstats.agi.md new file mode 100644 index 000000000..3d4061293 --- /dev/null +++ b/markdown/bitburner.stringstats.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [agi](./bitburner.stringstats.agi.md) + +## stringStats.agi property + +Agility multiplier + +Signature: + +```typescript +agi: number; +``` diff --git a/markdown/bitburner.stringstats.agiweight.md b/markdown/bitburner.stringstats.agiweight.md new file mode 100644 index 000000000..359496acd --- /dev/null +++ b/markdown/bitburner.stringstats.agiweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [agiWeight](./bitburner.stringstats.agiweight.md) + +## stringStats.agiWeight property + +Agility skill impact on task scaling + +Signature: + +```typescript +agiWeight: number; +``` diff --git a/markdown/bitburner.stringstats.basemoney.md b/markdown/bitburner.stringstats.basemoney.md new file mode 100644 index 000000000..fb23b57cf --- /dev/null +++ b/markdown/bitburner.stringstats.basemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [baseMoney](./bitburner.stringstats.basemoney.md) + +## stringStats.baseMoney property + +Base money earned + +Signature: + +```typescript +baseMoney: number; +``` diff --git a/markdown/bitburner.stringstats.baserespect.md b/markdown/bitburner.stringstats.baserespect.md new file mode 100644 index 000000000..4db9fcbb1 --- /dev/null +++ b/markdown/bitburner.stringstats.baserespect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [baseRespect](./bitburner.stringstats.baserespect.md) + +## stringStats.baseRespect property + +Base respect earned + +Signature: + +```typescript +baseRespect: number; +``` diff --git a/markdown/bitburner.stringstats.basewanted.md b/markdown/bitburner.stringstats.basewanted.md new file mode 100644 index 000000000..0da7c96c9 --- /dev/null +++ b/markdown/bitburner.stringstats.basewanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [baseWanted](./bitburner.stringstats.basewanted.md) + +## stringStats.baseWanted property + +Base wanted earned + +Signature: + +```typescript +baseWanted: number; +``` diff --git a/markdown/bitburner.stringstats.cha.md b/markdown/bitburner.stringstats.cha.md new file mode 100644 index 000000000..f35194146 --- /dev/null +++ b/markdown/bitburner.stringstats.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [cha](./bitburner.stringstats.cha.md) + +## stringStats.cha property + +Charisma multiplier + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.stringstats.chaweight.md b/markdown/bitburner.stringstats.chaweight.md new file mode 100644 index 000000000..2264fdc7e --- /dev/null +++ b/markdown/bitburner.stringstats.chaweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [chaWeight](./bitburner.stringstats.chaweight.md) + +## stringStats.chaWeight property + +Charisma skill impact on task scaling + +Signature: + +```typescript +chaWeight: number; +``` diff --git a/markdown/bitburner.stringstats.def.md b/markdown/bitburner.stringstats.def.md new file mode 100644 index 000000000..c6f31846b --- /dev/null +++ b/markdown/bitburner.stringstats.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [def](./bitburner.stringstats.def.md) + +## stringStats.def property + +Defense multiplier + +Signature: + +```typescript +def: number; +``` diff --git a/markdown/bitburner.stringstats.defweight.md b/markdown/bitburner.stringstats.defweight.md new file mode 100644 index 000000000..b3a9e5159 --- /dev/null +++ b/markdown/bitburner.stringstats.defweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [defWeight](./bitburner.stringstats.defweight.md) + +## stringStats.defWeight property + +Defense skill impact on task scaling + +Signature: + +```typescript +defWeight: number; +``` diff --git a/markdown/bitburner.stringstats.desc.md b/markdown/bitburner.stringstats.desc.md new file mode 100644 index 000000000..9635932d0 --- /dev/null +++ b/markdown/bitburner.stringstats.desc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [desc](./bitburner.stringstats.desc.md) + +## stringStats.desc property + +Task Description + +Signature: + +```typescript +desc: string; +``` diff --git a/markdown/bitburner.stringstats.dex.md b/markdown/bitburner.stringstats.dex.md new file mode 100644 index 000000000..a697e29d8 --- /dev/null +++ b/markdown/bitburner.stringstats.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [dex](./bitburner.stringstats.dex.md) + +## stringStats.dex property + +Dexterity multiplier + +Signature: + +```typescript +dex: number; +``` diff --git a/markdown/bitburner.stringstats.dexweight.md b/markdown/bitburner.stringstats.dexweight.md new file mode 100644 index 000000000..887237cd4 --- /dev/null +++ b/markdown/bitburner.stringstats.dexweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [dexWeight](./bitburner.stringstats.dexweight.md) + +## stringStats.dexWeight property + +Dexterity skill impact on task scaling + +Signature: + +```typescript +dexWeight: number; +``` diff --git a/markdown/bitburner.stringstats.difficulty.md b/markdown/bitburner.stringstats.difficulty.md new file mode 100644 index 000000000..ed9454671 --- /dev/null +++ b/markdown/bitburner.stringstats.difficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [difficulty](./bitburner.stringstats.difficulty.md) + +## stringStats.difficulty property + +Number representing the difficulty of the task + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.stringstats.hack.md b/markdown/bitburner.stringstats.hack.md new file mode 100644 index 000000000..fa7cdaefd --- /dev/null +++ b/markdown/bitburner.stringstats.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [hack](./bitburner.stringstats.hack.md) + +## stringStats.hack property + +Hacking multiplier + +Signature: + +```typescript +hack: number; +``` diff --git a/markdown/bitburner.stringstats.hackweight.md b/markdown/bitburner.stringstats.hackweight.md new file mode 100644 index 000000000..9d42278ef --- /dev/null +++ b/markdown/bitburner.stringstats.hackweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [hackWeight](./bitburner.stringstats.hackweight.md) + +## stringStats.hackWeight property + +Hacking skill impact on task scaling + +Signature: + +```typescript +hackWeight: number; +``` diff --git a/markdown/bitburner.stringstats.iscombat.md b/markdown/bitburner.stringstats.iscombat.md new file mode 100644 index 000000000..c7f34334b --- /dev/null +++ b/markdown/bitburner.stringstats.iscombat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [isCombat](./bitburner.stringstats.iscombat.md) + +## stringStats.isCombat property + +Is a task of a combat gang + +Signature: + +```typescript +isCombat: boolean; +``` diff --git a/markdown/bitburner.stringstats.ishacking.md b/markdown/bitburner.stringstats.ishacking.md new file mode 100644 index 000000000..251546f96 --- /dev/null +++ b/markdown/bitburner.stringstats.ishacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [isHacking](./bitburner.stringstats.ishacking.md) + +## stringStats.isHacking property + +Is a task of a hacking gang + +Signature: + +```typescript +isHacking: boolean; +``` diff --git a/markdown/bitburner.stringstats.md b/markdown/bitburner.stringstats.md new file mode 100644 index 000000000..c5877010c --- /dev/null +++ b/markdown/bitburner.stringstats.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) + +## stringStats interface + +Object representing data representing a gang member task. + +Signature: + +```typescript +interface stringStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agi](./bitburner.stringstats.agi.md) | number | Agility multiplier | +| [agiWeight](./bitburner.stringstats.agiweight.md) | number | Agility skill impact on task scaling | +| [baseMoney](./bitburner.stringstats.basemoney.md) | number | Base money earned | +| [baseRespect](./bitburner.stringstats.baserespect.md) | number | Base respect earned | +| [baseWanted](./bitburner.stringstats.basewanted.md) | number | Base wanted earned | +| [cha](./bitburner.stringstats.cha.md) | number | Charisma multiplier | +| [chaWeight](./bitburner.stringstats.chaweight.md) | number | Charisma skill impact on task scaling | +| [def](./bitburner.stringstats.def.md) | number | Defense multiplier | +| [defWeight](./bitburner.stringstats.defweight.md) | number | Defense skill impact on task scaling | +| [desc](./bitburner.stringstats.desc.md) | string | Task Description | +| [dex](./bitburner.stringstats.dex.md) | number | Dexterity multiplier | +| [dexWeight](./bitburner.stringstats.dexweight.md) | number | Dexterity skill impact on task scaling | +| [difficulty](./bitburner.stringstats.difficulty.md) | number | Number representing the difficulty of the task | +| [hack](./bitburner.stringstats.hack.md) | number | Hacking multiplier | +| [hackWeight](./bitburner.stringstats.hackweight.md) | number | Hacking skill impact on task scaling | +| [isCombat](./bitburner.stringstats.iscombat.md) | boolean | Is a task of a combat gang | +| [isHacking](./bitburner.stringstats.ishacking.md) | boolean | Is a task of a hacking gang | +| [name](./bitburner.stringstats.name.md) | string | Task name | +| [str](./bitburner.stringstats.str.md) | number | Strength multiplier | +| [strWeight](./bitburner.stringstats.strweight.md) | number | Stength skill impact on task scaling | +| [territory](./bitburner.stringstats.territory.md) | [stringTerritory](./bitburner.stringterritory.md) | Territory impact on task scaling | + diff --git a/markdown/bitburner.stringstats.name.md b/markdown/bitburner.stringstats.name.md new file mode 100644 index 000000000..b253bcf39 --- /dev/null +++ b/markdown/bitburner.stringstats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [name](./bitburner.stringstats.name.md) + +## stringStats.name property + +Task name + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.stringstats.str.md b/markdown/bitburner.stringstats.str.md new file mode 100644 index 000000000..a684f03f8 --- /dev/null +++ b/markdown/bitburner.stringstats.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [str](./bitburner.stringstats.str.md) + +## stringStats.str property + +Strength multiplier + +Signature: + +```typescript +str: number; +``` diff --git a/markdown/bitburner.stringstats.strweight.md b/markdown/bitburner.stringstats.strweight.md new file mode 100644 index 000000000..62395ccd6 --- /dev/null +++ b/markdown/bitburner.stringstats.strweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [strWeight](./bitburner.stringstats.strweight.md) + +## stringStats.strWeight property + +Stength skill impact on task scaling + +Signature: + +```typescript +strWeight: number; +``` diff --git a/markdown/bitburner.stringstats.territory.md b/markdown/bitburner.stringstats.territory.md new file mode 100644 index 000000000..c331071b0 --- /dev/null +++ b/markdown/bitburner.stringstats.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringStats](./bitburner.stringstats.md) > [territory](./bitburner.stringstats.territory.md) + +## stringStats.territory property + +Territory impact on task scaling + +Signature: + +```typescript +territory: stringTerritory; +``` diff --git a/markdown/bitburner.stringterritory.md b/markdown/bitburner.stringterritory.md new file mode 100644 index 000000000..dadff6451 --- /dev/null +++ b/markdown/bitburner.stringterritory.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringTerritory](./bitburner.stringterritory.md) + +## stringTerritory interface + + +Signature: + +```typescript +interface stringTerritory +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [money](./bitburner.stringterritory.money.md) | number | Money gain impact on task scaling | +| [respect](./bitburner.stringterritory.respect.md) | number | Respect gain impact on task scaling | +| [wanted](./bitburner.stringterritory.wanted.md) | number | Wanted gain impact on task scaling | + diff --git a/markdown/bitburner.stringterritory.money.md b/markdown/bitburner.stringterritory.money.md new file mode 100644 index 000000000..3613e2477 --- /dev/null +++ b/markdown/bitburner.stringterritory.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringTerritory](./bitburner.stringterritory.md) > [money](./bitburner.stringterritory.money.md) + +## stringTerritory.money property + +Money gain impact on task scaling + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.stringterritory.respect.md b/markdown/bitburner.stringterritory.respect.md new file mode 100644 index 000000000..7b866b8b2 --- /dev/null +++ b/markdown/bitburner.stringterritory.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringTerritory](./bitburner.stringterritory.md) > [respect](./bitburner.stringterritory.respect.md) + +## stringTerritory.respect property + +Respect gain impact on task scaling + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.stringterritory.wanted.md b/markdown/bitburner.stringterritory.wanted.md new file mode 100644 index 000000000..5bb6f6b48 --- /dev/null +++ b/markdown/bitburner.stringterritory.wanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [stringTerritory](./bitburner.stringterritory.md) > [wanted](./bitburner.stringterritory.wanted.md) + +## stringTerritory.wanted property + +Wanted gain impact on task scaling + +Signature: + +```typescript +wanted: number; +``` diff --git a/markdown/bitburner.tix.buy.md b/markdown/bitburner.tix.buy.md index b316a467d..c8f967208 100644 --- a/markdown/bitburner.tix.buy.md +++ b/markdown/bitburner.tix.buy.md @@ -9,14 +9,14 @@ Buy stocks. Signature: ```typescript -buy(sym: StockSymbol, shares: number): number; +buy(sym: string, shares: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to purchased. Must be positive. Will be rounded to nearest integer. | Returns: diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md index c7ba936de..e7d7edd7c 100644 --- a/markdown/bitburner.tix.cancelorder.md +++ b/markdown/bitburner.tix.cancelorder.md @@ -9,18 +9,18 @@ Cancel order for stocks. Signature: ```typescript -cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): void; +cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | | price | number | Execution price for the order. | -| type | [OrderType](./bitburner.ordertype.md) | Type of order. | -| pos | [OrderPosition](./bitburner.orderposition.md) | Specifies whether the order is a “Long” or “Short” position. | +| type | string | Type of order. | +| pos | string | Specifies whether the order is a “Long” or “Short” position. | Returns: diff --git a/markdown/bitburner.tix.getaskprice.md b/markdown/bitburner.tix.getaskprice.md index 712800b78..1f33c26cd 100644 --- a/markdown/bitburner.tix.getaskprice.md +++ b/markdown/bitburner.tix.getaskprice.md @@ -9,14 +9,14 @@ Returns the ask price of that stock. Signature: ```typescript -getAskPrice(sym: StockSymbol): number; +getAskPrice(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getbidprice.md b/markdown/bitburner.tix.getbidprice.md index 6f8129902..a2d00d8b1 100644 --- a/markdown/bitburner.tix.getbidprice.md +++ b/markdown/bitburner.tix.getbidprice.md @@ -9,14 +9,14 @@ Returns the bid price of that stock. Signature: ```typescript -getBidPrice(sym: StockSymbol): number; +getBidPrice(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getforecast.md b/markdown/bitburner.tix.getforecast.md index 975621200..4fa0c0043 100644 --- a/markdown/bitburner.tix.getforecast.md +++ b/markdown/bitburner.tix.getforecast.md @@ -9,14 +9,14 @@ Returns the probability that the specified stock’s price will increase (as opp Signature: ```typescript -getForecast(sym: StockSymbol): number; +getForecast(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getmaxshares.md b/markdown/bitburner.tix.getmaxshares.md index 86214489c..ec152466f 100644 --- a/markdown/bitburner.tix.getmaxshares.md +++ b/markdown/bitburner.tix.getmaxshares.md @@ -9,14 +9,14 @@ Returns the maximum number of shares of a stock. Signature: ```typescript -getMaxShares(sym: StockSymbol): number; +getMaxShares(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getorders.md b/markdown/bitburner.tix.getorders.md index 89bfcbf03..a66b68f71 100644 --- a/markdown/bitburner.tix.getorders.md +++ b/markdown/bitburner.tix.getorders.md @@ -23,7 +23,7 @@ RAM cost: 2.5 GB This is an object containing information for all the Limit and ```ts { - StockSymbol1: [ // Array of orders for this stock + string1: [ // Array of orders for this stock { shares: Order quantity price: Order price @@ -35,7 +35,7 @@ RAM cost: 2.5 GB This is an object containing information for all the Limit and }, ... ], - StockSymbol2: [ // Array of orders for this stock + string2: [ // Array of orders for this stock ... ], ... diff --git a/markdown/bitburner.tix.getposition.md b/markdown/bitburner.tix.getposition.md index 9bd56e246..7a531a6c8 100644 --- a/markdown/bitburner.tix.getposition.md +++ b/markdown/bitburner.tix.getposition.md @@ -9,14 +9,14 @@ Returns the player’s position in a stock. Signature: ```typescript -getPosition(sym: StockSymbol): [number, number, number, number]; +getPosition(sym: string): [number, number, number, number]; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md index 3779a37b6..57af0861d 100644 --- a/markdown/bitburner.tix.getprice.md +++ b/markdown/bitburner.tix.getprice.md @@ -9,14 +9,14 @@ Returns the price of a stock Signature: ```typescript -getPrice(sym: StockSymbol): number; +getPrice(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.getpurchasecost.md b/markdown/bitburner.tix.getpurchasecost.md index 21a073a5e..7eb12f88c 100644 --- a/markdown/bitburner.tix.getpurchasecost.md +++ b/markdown/bitburner.tix.getpurchasecost.md @@ -9,16 +9,16 @@ Calculates cost of buying stocks. Signature: ```typescript -getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPosition): number; +getPurchaseCost(sym: string, shares: number, posType: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to purchase. | -| posType | [OrderPosition](./bitburner.orderposition.md) | Specifies whether the order is a “Long” or “Short” position. | +| posType | string | Specifies whether the order is a “Long” or “Short” position. | Returns: diff --git a/markdown/bitburner.tix.getsalegain.md b/markdown/bitburner.tix.getsalegain.md index 3acbbbff3..48745671d 100644 --- a/markdown/bitburner.tix.getsalegain.md +++ b/markdown/bitburner.tix.getsalegain.md @@ -9,16 +9,16 @@ Calculate profit of setting stocks. Signature: ```typescript -getSaleGain(sym: StockSymbol, shares: number, posType: OrderPosition): number; +getSaleGain(sym: string, shares: number, posType: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to sell. | -| posType | [OrderPosition](./bitburner.orderposition.md) | Specifies whether the order is a “Long” or “Short” position. | +| posType | string | Specifies whether the order is a “Long” or “Short” position. | Returns: diff --git a/markdown/bitburner.tix.getsymbols.md b/markdown/bitburner.tix.getsymbols.md index 621ff8fda..8ec52e5d9 100644 --- a/markdown/bitburner.tix.getsymbols.md +++ b/markdown/bitburner.tix.getsymbols.md @@ -9,11 +9,11 @@ Returns an array of the symbols of the tradable stocks Signature: ```typescript -getSymbols(): StockSymbol[]; +getSymbols(): string[]; ``` Returns: -[StockSymbol](./bitburner.stocksymbol.md)\[\] +string\[\] Array of the symbols of the tradable stocks. diff --git a/markdown/bitburner.tix.getvolatility.md b/markdown/bitburner.tix.getvolatility.md index 23fe158aa..b38afb066 100644 --- a/markdown/bitburner.tix.getvolatility.md +++ b/markdown/bitburner.tix.getvolatility.md @@ -9,14 +9,14 @@ Returns the volatility of the specified stock. Signature: ```typescript -getVolatility(sym: StockSymbol): number; +getVolatility(sym: string): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | Returns: diff --git a/markdown/bitburner.tix.placeorder.md b/markdown/bitburner.tix.placeorder.md index 0af38eaa3..59a9cba98 100644 --- a/markdown/bitburner.tix.placeorder.md +++ b/markdown/bitburner.tix.placeorder.md @@ -9,18 +9,18 @@ Place order for stocks. Signature: ```typescript -placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): boolean; +placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | | price | number | Execution price for the order. | -| type | [OrderType](./bitburner.ordertype.md) | Type of order. | -| pos | [OrderPosition](./bitburner.orderposition.md) | Specifies whether the order is a “Long” or “Short” position. | +| type | string | Type of order. | +| pos | string | Specifies whether the order is a “Long” or “Short” position. | Returns: diff --git a/markdown/bitburner.tix.sell.md b/markdown/bitburner.tix.sell.md index 1c9ed983a..60778fd0b 100644 --- a/markdown/bitburner.tix.sell.md +++ b/markdown/bitburner.tix.sell.md @@ -9,14 +9,14 @@ Sell stocks. Signature: ```typescript -sell(sym: StockSymbol, shares: number): number; +sell(sym: string, shares: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | Returns: diff --git a/markdown/bitburner.tix.sellshort.md b/markdown/bitburner.tix.sellshort.md index aefd398d8..f5081991a 100644 --- a/markdown/bitburner.tix.sellshort.md +++ b/markdown/bitburner.tix.sellshort.md @@ -9,14 +9,14 @@ Sell short stock. Signature: ```typescript -sellShort(sym: StockSymbol, shares: number): number; +sellShort(sym: string, shares: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | Returns: diff --git a/markdown/bitburner.tix.short.md b/markdown/bitburner.tix.short.md index 78bb435a4..f4fb0a1af 100644 --- a/markdown/bitburner.tix.short.md +++ b/markdown/bitburner.tix.short.md @@ -9,14 +9,14 @@ Short stocks. Signature: ```typescript -short(sym: StockSymbol, shares: number): number; +short(sym: string, shares: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| sym | string | Stock symbol. | | shares | number | Number of shares to short. Must be positive. Will be rounded to nearest integer. | Returns: diff --git a/markdown/bitburner.university.md b/markdown/bitburner.university.md deleted file mode 100644 index 6f475275e..000000000 --- a/markdown/bitburner.university.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [University](./bitburner.university.md) - -## University type - -All universities. - -Signature: - -```typescript -type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; -``` diff --git a/markdown/bitburner.universitycourse.md b/markdown/bitburner.universitycourse.md deleted file mode 100644 index 251926ef7..000000000 --- a/markdown/bitburner.universitycourse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [UniversityCourse](./bitburner.universitycourse.md) - -## UniversityCourse type - -All university courses. - -Signature: - -```typescript -type UniversityCourse = - | "Study Computer Science" - | "Data Strucures" - | "Networks" - | "Algorithms" - | "Management" - | "Leadership"; -``` diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 08b2c0296..cead9a245 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1,365 +1,3 @@ -/** - * All possible stock market symbols. - * @public - */ -type StockSymbol = - | "ECP" - | "MGCP" - | "BLD" - | "CLRK" - | "OMTK" - | "FSIG" - | "KGI" - | "FLCM" - | "STM" - | "DCOMM" - | "HLS" - | "VITA" - | "ICRS" - | "UNV" - | "AERO" - | "OMN" - | "SLRS" - | "GPH" - | "NVMD" - | "WDS" - | "LXO" - | "RHOC" - | "APHE" - | "SYSC" - | "CTK" - | "NTLK" - | "OMGA" - | "FNS" - | "SGC" - | "JGN" - | "CTYS" - | "MDYN" - | "TITN"; - -/** - * All possible stock market order type. - * @public - */ -type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; - -/** - * All possible stock market order positions. - * @public - */ -type OrderPosition = "long" | "short"; - -/** - * All universities. - * @public - */ -type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; - -/** - * All university courses. - * @public - */ -type UniversityCourse = - | "Study Computer Science" - | "Data Strucures" - | "Networks" - | "Algorithms" - | "Management" - | "Leadership"; - -/** - * All gyms. - * @public - */ -type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; - -/** - * All stats that can be trained at gyms. - * @public - */ -type GymStat = "str" | "def" | "dex" | "agi"; - -/** - * All cities. - * @public - */ -type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; - -/** - * All programs. - * @public - */ -type Programs = - | "autolink.exe" - | "brutessh.exe" - | "deepscanv1.exe" - | "deepscanv2.exe" - | "ftpcrack.exe" - | "httpworm.exe" - | "relaysmtp.exe" - | "serverprofiler.exe" - | "sqlinject.exe"; - -/** - * All companies. - * @public - */ -type CompanyName = - // Sector-12 - | "MegaCorp" - | "BladeIndustries" - | "FourSigma" - | "IcarusMicrosystems" - | "UniversalEnergy" - | "DeltaOne" - | "CIA" - | "NSA" - | "AlphaEnterprises" - | "CarmichaelSecurity" - | "FoodNStuff" - | "JoesGuns" - - // Aevum - | "ECorp" - | "BachmanAndAssociates" - | "ClarkeIncorporated" - | "OmniTekIncorporated" - | "FulcrumTechnologies" - | "GalacticCybersystems" - | "AeroCorp" - | "WatchdogSecurity" - | "RhoConstruction" - | "AevumPolice" - | "NetLinkTechnologies" - - // Volhaven - | "NWO" - | "HeliosLabs" - | "OmniaCybersystems" - | "LexoCorp" - | "SysCoreSecurities" - | "CompuTek" - - // Chongqing - | "KuaiGongInternational" - | "SolarisSpaceSystems" - - // Ishima - | "StormTechnologies" - | "NovaMedical" - | "OmegaSoftware" - - // New Tokyo - | "DefComm" - | "VitaLife" - | "GlobalPharmaceuticals" - | "NoodleBar"; - -/** - * All company work fields. - * @public - */ -type CompanyField = - | "software" - | "software consultant" - | "it" - | "security engineer" - | "network engineer" - | "business" - | "business consultant" - | "security" - | "agent" - | "employee" - | "part-time employee" - | "waiter" - | "part-time waiter"; - -/** - * All factions. - * @public - */ -type FactionName = - | "Illuminati" - | "Daedalus" - | "The Covenant" - | "ECorp" - | "MegaCorp" - | "Bachman & Associates" - | "Blade Industries" - | "NWO" - | "Clarke Incorporated" - | "OmniTek Incorporated" - | "Four Sigma" - | "KuaiGong International" - | "Fulcrum Secret Technologies" - | "BitRunners" - | "The Black Hand" - | "NiteSec" - | "Aevum" - | "Chongqing" - | "Ishima" - | "New Tokyo" - | "Sector-12" - | "Volhaven" - | "Speakers for the Dead" - | "The Dark Army" - | "The Syndicate" - | "Silhouette" - | "Tetrads" - | "Slum Snakes" - | "Netburners" - | "Tian Di Hui" - | "CyberSec" - | "Bladeburners"; - -/** - * All factions that can have a gang. - * @public - */ -type GangName = - | "Slum Snakes" - | "Tetrads" - | "The Syndicate" - | "The Dark Army" - | "Speakers for the Dead" - | "NiteSec" - | "The Black Hand"; - -/** - * All faction work types. - * @public - */ -type FactionWork = "hacking" | "field" | "security"; - -/** - * All crimes. - * @public - */ -type Crime = - | "shoplift" - | "rob store" - | "mug" - | "larceny" - | "deal drugs" - | "bond forgery" - | "traffick arms" - | "homicide" - | "grand theft auto" - | "kidnap" - | "assassinate" - | "heist"; - -/** - * All augmentation names. - * @public - */ -type AugmentName = - | "Augmented Targeting I" - | "Augmented Targeting II" - | "Augmented Targeting III" - | "Synthetic Heart" - | "Synfibril Muscle" - | "Combat Rib I" - | "Combat Rib II" - | "Combat Rib III" - | "Nanofiber Weave" - | "NEMEAN Subdermal Weave" - | "Wired Reflexes" - | "Graphene Bone Lacings" - | "Bionic Spine" - | "Graphene Bionic Spine Upgrade" - | "Bionic Legs" - | "Graphene Bionic Legs Upgrade" - | "Speech Processor Implant" - | "TITN-41 Gene-Modification Injection" - | "Enhanced Social Interaction Implant" - | "BitWire" - | "Artificial Bio-neural Network Implant" - | "Artificial Synaptic Potentiation" - | "Enhanced Myelin Sheathing" - | "Synaptic Enhancement Implant" - | "Neural-Retention Enhancement" - | "DataJack" - | "Embedded Netburner Module" - | "Embedded Netburner Module Core Implant" - | "Embedded Netburner Module Core V2 Upgrade" - | "Embedded Netburner Module Core V3 Upgrade" - | "Embedded Netburner Module Analyze Engine" - | "Embedded Netburner Module Direct Memory Access Upgrade" - | "Neuralstimulator" - | "Neural Accelerator" - | "Cranial Signal Processors - Gen I" - | "Cranial Signal Processors - Gen II" - | "Cranial Signal Processors - Gen III" - | "Cranial Signal Processors - Gen IV" - | "Cranial Signal Processors - Gen V" - | "Neuronal Densification" - | "Nuoptimal Nootropic Injector Implant" - | "Speech Enhancement" - | "FocusWire" - | "PC Direct-Neural Interface" - | "PC Direct-Neural Interface Optimization Submodule" - | "PC Direct-Neural Interface NeuroNet Injector" - | "ADR-V1 Pheromone Gene" - | "ADR-V2 Pheromone Gene" - | "The Shadow's Simulacrum" - | "Hacknet Node CPU Architecture Neural-Upload" - | "Hacknet Node Cache Architecture Neural-Upload" - | "Hacknet Node NIC Architecture Neural-Upload" - | "Hacknet Node Kernel Direct-Neural Interface" - | "Hacknet Node Core Direct-Neural Interface" - | "NeuroFlux Governor" - | "Neurotrainer I" - | "Neurotrainer II" - | "Neurotrainer III" - | "HyperSight Corneal Implant" - | "LuminCloaking-V1 Skin Implant" - | "LuminCloaking-V2 Skin Implant" - | "HemoRecirculator" - | "SmartSonar Implant" - | "Power Recirculation Core" - | "QLink" - | "The Red Pill" - | "SPTN-97 Gene Modification" - | "ECorp HVMind Implant" - | "CordiARC Fusion Reactor" - | "SmartJaw" - | "Neotra" - | "Xanipher" - | "nextSENS Gene Modification" - | "OmniTek InfoLoad" - | "Photosynthetic Cells" - | "BitRunners Neurolink" - | "The Black Hand" - | "CRTX42-AA Gene Modification" - | "Neuregen Gene Modification" - | "CashRoot Starter Kit" - | "NutriGen Implant" - | "INFRARET Enhancement" - | "DermaForce Particle Barrier" - | "Graphene BranchiBlades Upgrade" - | "Graphene Bionic Arms Upgrade" - | "BrachiBlades" - | "Bionic Arms" - | "Social Negotiation Assistant (S.N.A)" - | "EsperTech Bladeburner Eyewear" - | "EMS-4 Recombination" - | "ORION-MKIV Shoulder" - | "Hyperion Plasma Cannon V1" - | "Hyperion Plasma Cannon V2" - | "GOLEM Serum" - | "Vangelis Virus" - | "Vangelis Virus 3.0" - | "I.N.T.E.R.L.I.N.K.E.D" - | "Blade's Runners" - | "BLADE-51b Tesla Armor" - | "BLADE-51b Tesla Armor: Power Cells Upgrade" - | "BLADE-51b Tesla Armor: Energy Shielding Upgrade" - | "BLADE-51b Tesla Armor: Unibeam Upgrade" - | "BLADE-51b Tesla Armor: Omnibeam Upgrade" - | "BLADE-51b Tesla Armor: IPU Upgrade" - | "The Blade's Simulacrum"; - /** * Data representing the internal values of a crime. * @public @@ -500,7 +138,7 @@ interface CodingAttemptOptions { */ interface AugmentPair { /** augmentation name */ - name: AugmentName; + name: string; /** augmentation cost */ cost: number; } @@ -515,9 +153,9 @@ interface StockOrderObject { /** Price per share */ price: number; /** Order type */ - type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; + type: string; /** Order position */ - position: "S" | "L"; + position: string; } /** @@ -526,7 +164,7 @@ interface StockOrderObject { */ type StockOrder = { /** Stock Symbol */ - [key in StockSymbol]?: StockOrderObject[]; + [key: string]: StockOrderObject[]; }; /** @@ -721,7 +359,7 @@ interface BitNodeMultipliers { * then you will lose all of the data in the ports! * @public */ -type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; +type Port = number; /** * @public @@ -753,22 +391,6 @@ interface NodeStats { totalProduction: number; } -/** - * All Hash upgrade names. - * @public - */ -type HashUpgrades = - | "Sell for Money" - | "Sell for Corporation Funds" - | "Reduce Minimum Security" - | "Increase Maximum Money" - | "Improve Studying" - | "Improve Gym Training" - | "Exchange for Corporation Research" - | "Exchange for Bladeburner Rank" - | "Exchange for Bladeburner SP" - | "Generate Coding Contract"; - /** * Short summary of the players skills. * @public @@ -833,15 +455,15 @@ interface CharacterInfo { /** Current BitNode number */ bitnode: number; /** Name of city you are currently in */ - city: City; + city: string; /** Array of factions you are currently a member of */ - factions: FactionName[]; + factions: string[]; /** Current health points */ hp: number; /** Array of all companies at which you have jobs */ - company: CompanyName[]; + company: string[]; /** Array of job positions for all companies you are employed at. Same order as 'jobs' */ - jobTitle: CompanyField[]; + jobTitle: string[]; /** Maximum health points */ maxHp: number; /** Boolean indicating whether or not you have a tor router */ @@ -898,127 +520,24 @@ interface SourceFileLvl { lvl: number; } -/** - * @public - */ -type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; - -/** - * All Bladeburner Ops. - * @public - */ -type BladeburnerOperations = - | "Investigation" - | "Undercover Operation" - | "Sting Operation" - | "Raid" - | "Stealth Retirement Operation" - | "Assassination"; - -/** - * All Bladeburner black ops. - * @public - */ -type BladeburnerBlackOps = - | "Operation Typhoon" - | "Operation Zero" - | "Operation X" - | "Operation Titan" - | "Operation Ares" - | "Operation Archangel" - | "Operation Juggernaut" - | "Operation Red Dragon" - | "Operation K" - | "Operation Deckard" - | "Operation Tyrell" - | "Operation Wallace" - | "Operation Shoulder of Orion" - | "Operation Hyron" - | "Operation Morpheus" - | "Operation Ion Storm" - | "Operation Annihilus" - | "Operation Ultron" - | "Operation Centurion" - | "Operation Vindictus" - | "Operation Daedalus"; - -/** - * All Bladeburner General Actions. - * @public - */ -type BladeburnerGenActions = - | "Training" - | "Field Analysis" - | "Recruitment" - | "Diplomacy" - | "Hyperbolic Regeneration Chamber"; - -/** - * All Bladeburner Skills. - * @public - */ -type BladeburnerSkills = - | "Blade's Intuition" - | "Cloak" - | "Marksman" - | "Weapon Proficiency" - | "Short-Circuit" - | "Digital Observer" - | "Tracer" - | "Overclock" - | "Reaper" - | "Evasive System" - | "Datamancer" - | "Cyber's Edge" - | "Hands of Midas" - | "Hyperdrive"; - -/** - * All Bladeburner action types. - * @public - */ -type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; - /** * Bladeburner current action. * @public */ interface BladeburnerCurAction { /** Type of Action */ - type: BladeburnerActTypes | "Idle"; + type: string; /** Name of Action */ - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; + name: string; } -/** - * All Coding contract types. - * @public - */ -type CodingContractTypes = - | "Find Largest Prime Factor" - | "Subarray with Maximum Sum" - | "Total Ways to Sum" - | "Spiralize Matrix" - | "Array Jumping Game" - | "Merge Overlapping Intervals" - | "Generate IP Addresses" - | "Algorithmic Stock Trader I" - | "Algorithmic Stock Trader II" - | "Algorithmic Stock Trader III" - | "Algorithmic Stock Trader IV" - | "Minimum Path Sum in a Triangle" - | "Unique Paths in a Grid I" - | "Unique Paths in a Grid II" - | "Sanitize Parentheses in Expression" - | "Find All Valid Math Expressions"; - /** * Gang general info. * @public */ interface GangGenInfo { /** Name of faction that the gang belongs to ("Slum Snakes", etc.) */ - faction: GangName; + faction: string; /** Boolean indicating whether or not its a hacking gang */ isHacking: boolean; /** Money earned per second */ @@ -1054,96 +573,16 @@ interface GangOtherInfoObject { */ type GangOtherInfo = { /** Stock Symbol */ - [key in GangName]: GangOtherInfoObject[]; + [key: string]: GangOtherInfoObject[]; }; -/** - * All Gang equipment. - * @public - */ -type GangEquipment = - | "Baseball Bat" - | "Katana" - | "Glock 18C" - | "P90C" - | "Steyr AUG" - | "AK-47" - | "M15A10 Assault Rifle" - | "AWM Sniper Rifle" - | "Bulletproof Vest" - | "Full Body Armor" - | "Liquid Body Armor" - | "Graphene Plating Armor" - | "Ford Flex V20" - | "ATX1070 Superbike" - | "Mercedes-Benz S9001" - | "White Ferrari" - | "NUKE Rootkit" - | "Soulstealer Rootkit" - | "Demon Rootkit" - | "Hmap Node" - | "Jack the Ripper"; - -/** - * All Gang equipment type. - * @public - */ -type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; - -/** - * All Gang augmentations. - * @public - */ -type GangAugmentations = - | "Bionic Arms" - | "Bionic Legs" - | "Bionic Spine" - | "BrachiBlades" - | "Nanofiber Weave" - | "Synthetic Heart" - | "Synfibril Muscle" - | "BitWire" - | "Neuralstimulator" - | "DataJack" - | "Graphene Bone Lacings"; - -/** - * All Gang tasks. - * @public - */ -type GangTasks = - | "Unassigned" - | "Ransomware" - | "Phishing" - | "Identity Theft" - | "DDoS Attacks" - | "Plant Virus" - | "Fraud & Counterfeiting" - | "Money Laundering" - | "Cyberterrorism" - | "Ethical Hacking" - | "Mug People" - | "Deal Drugs" - | "Strongarm Civilians" - | "Run a Con" - | "Armed Robbery" - | "Traffick Illegal Arms" - | "Threaten & Blackmail" - | "Human Trafficking" - | "Terrorism" - | "Vigilante Justice" - | "Train Combat" - | "Train Hacking" - | "Train Charisma" - | "Territory Warfare"; - /** * Object representing data representing a gang member task. * @public */ -interface GangTasksStats { +interface stringStats { /** Task name */ - name: GangTasks; + name: string; /** Task Description */ desc: string; /** Is a task of a hacking gang */ @@ -1171,14 +610,14 @@ interface GangTasksStats { /** Number representing the difficulty of the task */ difficulty: number; /** Territory impact on task scaling */ - territory: GangTasksTerritory; + territory: stringTerritory; } /** * Object representing data representing a gang member equipment. * @public */ -interface GangEquipmentStats { +interface stringStats { /** Strength multiplier */ str: number; /** Defense multiplier */ @@ -1196,7 +635,7 @@ interface GangEquipmentStats { /** * @public */ -interface GangTasksTerritory { +interface stringTerritory { /** Money gain impact on task scaling */ money: number; /** Respect gain impact on task scaling */ @@ -1216,7 +655,7 @@ interface GangMemberInfo { /** Agility multiplier from ascension.*/ agilityAscensionMult: number; /** Array of names of all owned Augmentations */ - augmentations: GangAugmentations[]; + augmentations: string[]; /** Charisma stat */ charisma: number; /** Charisma multiplier from equipment.*/ @@ -1236,7 +675,7 @@ interface GangMemberInfo { /** Dexterity multiplier from ascension.*/ dexterityAscensionMult: number; /** Array of names of all owned Non-Augmentation Equipment */ - equipment: GangEquipment[]; + equipment: string[]; /** Hacking stat */ hacking: number; /** Hacking multiplier from equipment.*/ @@ -1250,7 +689,7 @@ interface GangMemberInfo { /** Strength multiplier from ascension.*/ strengthAscensionMult: number; /** Name of currently assigned task */ - task: GangTasks; + task: string; } /** @@ -1302,7 +741,7 @@ interface SleeveSkills { */ interface SleeveInformation { /** location of the sleeve */ - city: City; + city: string; /** current hp of the sleeve */ hp: number; /** max hp of the sleeve */ @@ -1310,7 +749,7 @@ interface SleeveInformation { /** jobs available to the sleeve */ jobs: string[]; /** job titles available to the sleeve */ - jobTitle: CompanyField[]; + jobTitle: string[]; /** does this sleeve have access to the tor router */ tor: boolean; /** sleeve multipliers */ @@ -1335,13 +774,13 @@ interface SleeveTask { /** task type */ task: string; /** crime currently attempting, if any */ - crime: Crime | ""; + crime: string; /** location of the task, if any */ - location: City | ""; + location: string; /** stat being trained at the gym, if any */ - gymStatType: GymStat | ""; + gymStatType: string; /** faction work type being performed, if any */ - factionWorkType: FactionWork | ""; + factionWorkType: string; } /** @@ -1355,7 +794,7 @@ export interface TIX { * @remarks RAM cost: 2 GB * @returns Array of the symbols of the tradable stocks. */ - getSymbols(): StockSymbol[]; + getSymbols(): string[]; /** * Returns the price of a stock @@ -1371,7 +810,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns The price of a stock. */ - getPrice(sym: StockSymbol): number; + getPrice(sym: string): number; /** * Returns the ask price of that stock. @@ -1380,7 +819,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns The ask price of a stock. */ - getAskPrice(sym: StockSymbol): number; + getAskPrice(sym: string): number; /** * Returns the bid price of that stock. @@ -1389,7 +828,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns The bid price of a stock. */ - getBidPrice(sym: StockSymbol): number; + getBidPrice(sym: string): number; /** * Returns the player’s position in a stock. @@ -1418,7 +857,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns Array of four elements that represents the player’s position in a stock. */ - getPosition(sym: StockSymbol): [number, number, number, number]; + getPosition(sym: string): [number, number, number, number]; /** * Returns the maximum number of shares of a stock. @@ -1430,7 +869,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns Maximum number of shares that the stock has. */ - getMaxShares(sym: StockSymbol): number; + getMaxShares(sym: string): number; /** * Calculates cost of buying stocks. @@ -1444,7 +883,7 @@ export interface TIX { * @param posType - Specifies whether the order is a “Long” or “Short” position. * @returns Cost to buy a given number of shares of a stock. */ - getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPosition): number; + getPurchaseCost(sym: string, shares: number, posType: string): number; /** * Calculate profit of setting stocks. @@ -1458,7 +897,7 @@ export interface TIX { * @param posType - Specifies whether the order is a “Long” or “Short” position. * @returns Gain from selling a given number of shares of a stock. */ - getSaleGain(sym: StockSymbol, shares: number, posType: OrderPosition): number; + getSaleGain(sym: string, shares: number, posType: string): number; /** * Buy stocks. @@ -1477,7 +916,7 @@ export interface TIX { * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ - buy(sym: StockSymbol, shares: number): number; + buy(sym: string, shares: number): number; /** * Sell stocks. @@ -1501,7 +940,7 @@ export interface TIX { * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ - sell(sym: StockSymbol, shares: number): number; + sell(sym: string, shares: number): number; /** * Short stocks. @@ -1523,7 +962,7 @@ export interface TIX { * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ - short(sym: StockSymbol, shares: number): number; + short(sym: string, shares: number): number; /** * Sell short stock. @@ -1545,7 +984,7 @@ export interface TIX { * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ - sellShort(sym: StockSymbol, shares: number): number; + sellShort(sym: string, shares: number): number; /** * Place order for stocks. @@ -1565,7 +1004,7 @@ export interface TIX { * @param pos - Specifies whether the order is a “Long” or “Short” position. * @returns True if the order is successfully placed, and false otherwise. */ - placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): boolean; + placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean; /** * Cancel order for stocks. @@ -1582,7 +1021,7 @@ export interface TIX { * @param type - Type of order. * @param pos - Specifies whether the order is a “Long” or “Short” position. */ - cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): void; + cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void; /** * Returns your order book for the stock market. @@ -1593,7 +1032,7 @@ export interface TIX { * * ```ts * { - * StockSymbol1: [ // Array of orders for this stock + * string1: [ // Array of orders for this stock * { * shares: Order quantity * price: Order price @@ -1605,7 +1044,7 @@ export interface TIX { * }, * ... * ], - * StockSymbol2: [ // Array of orders for this stock + * string2: [ // Array of orders for this stock * ... * ], * ... @@ -1659,7 +1098,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns Volatility of the specified stock. */ - getVolatility(sym: StockSymbol): number; + getVolatility(sym: string): number; /** * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. @@ -1676,7 +1115,7 @@ export interface TIX { * @param sym - Stock symbol. * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. */ - getForecast(sym: StockSymbol): number; + getForecast(sym: string): number; /** * Purchase 4S Market Data Access. @@ -1695,11 +1134,18 @@ export interface TIX { /** * Singularity API + * @remarks + * This API requires Source-File 4 level 1 / 2 / 3 to use. * @public */ interface Singularity { /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Take university class. + * + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -1709,17 +1155,20 @@ interface Singularity { * The cost and experience gains for all of these universities and classes are the same as * if you were to manually visit and take these classes. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param universityName - Name of university. You must be in the correct city for whatever university you specify. * @param courseName - Name of course. * @returns True if actions is successfully started, false otherwise. */ - universityCourse(universityName: University, courseName: UniversityCourse): boolean; + universityCourse(universityName: string, courseName: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - * + * Workout at the gym. + * + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -1728,42 +1177,48 @@ interface Singularity { * The cost and experience gains for all of these gyms are the same as if you were * to manually visit these gyms and train * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify. * @param stat - The stat you want to train. * @returns True if actions is successfully started, false otherwise. */ - gymWorkout(gymName: Gym, stat: GymStat): boolean; + gymWorkout(gymName: string, stat: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Travel to another city. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param city - City to travel to. * @returns True if actions is successful, false otherwise. */ - travelToCity(city: City): boolean; + travelToCity(city: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase the TOR router. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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. * - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @returns True if actions is successful, false otherwise. */ purchaseTor(): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase a program from the dark web. + * @remarks + * RAM cost: 2 GB + * + * Singularity - Level 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 @@ -1774,55 +1229,32 @@ interface Singularity { * ```ts * purchaseProgram("brutessh.exe"); * ``` - * @remarks RAM cost: 2 GB - * @remarks Singularity - Level 1 * @param programName - Name of program to purchase. * @returns True if the specified program is purchased, and false otherwise. */ - purchaseProgram(programName: Programs): boolean; + purchaseProgram(programName: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Check if the player is busy. + * @remarks + * RAM cost: 0.5 GB * - * Returns an object with the Player’s stats. - * - * @example - * ```ts - * res = getStats(); - * print('My charisma level is: ' + res.charisma); - * ``` - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 - * @returns Object with the Player’s stats. - */ - getStats(): PlayerSkills; - - /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. - * - * Returns an object with various information about your character. - * - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 - * @returns Object with various information about your character. - */ - getCharacterInformation(): CharacterInfo; - - /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Singularity - Level 1 * * Returns a boolean indicating whether or not the player is currently performing an * ‘action’. These actions include working for a company/faction, studying at a univeristy, * working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. * - * @remarks RAM cost: 0.5 GB - * @remarks Singularity - Level 1 * @returns True if the player is currently performing an ‘action’, false otherwise. */ isBusy(): boolean; /** - * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Stop the current action. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 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. @@ -1837,39 +1269,45 @@ interface Singularity { * This function will return true if the player’s action was ended. * It will return false if the player was not performing an action when this function was called. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 1 * @returns True if the player’s action was ended, false if the player was not performing an action. */ stopAction(): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Upgrade home computer RAM. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will upgrade amount of RAM on the player’s home computer. The cost is * the same as if you were to do it manually. * * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise. */ upgradeHomeRam(): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the price of upgrading home RAM. + * @remarks + * RAM cost: 1.5 GB + * + * Singularity - Level 2 * * Returns the cost of upgrading the player’s home computer RAM. * - * @remarks RAM cost: 1.5 GB - * @remarks Singularity - Level 2 * @returns Cost of upgrading the player’s home computer RAM. */ getUpgradeHomeRamCost(): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Work for a company. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically set you to start working at the company * at which you are employed. If you are already in the middle of some “working” @@ -1890,15 +1328,17 @@ interface Singularity { * } * //This way, your company reputation will be updated every minute. * ``` - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked * @returns True if the player starts working, and false otherwise. */ - workForCompany(companyName?: CompanyName): boolean; + workForCompany(companyName?: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Apply for a job at a company. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * 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 @@ -1909,78 +1349,90 @@ interface Singularity { * and false otherwise. Note that if you are trying to use this function to * apply for a promotion and you don’t get one, it will return false. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param companyName - Name of company to apply to. * @param field - Field to which you want to apply. * @returns True if the player successfully get a job/promotion, and false otherwise. */ - applyToCompany(companyName: CompanyName, field: CompanyField): boolean; + applyToCompany(companyName: string, field: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company reputation. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function will return the amount of reputation you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of reputation you have at the specified company. */ - getCompanyRep(companyName: CompanyName): number; + getCompanyRep(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company favor. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function will return the amount of favor you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of favor you have at the specified company. */ - getCompanyFavor(companyName: CompanyName): number; + getCompanyFavor(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get company favor gain. + * @remarks + * RAM cost: 0.75 GB + * + * Singularity - Level 2 * * This function will return the amount of favor you will gain for the specified * company when you reset by installing Augmentations. * - * @remarks RAM cost: 0.75 GB - * @remarks Singularity - Level 2 * @param companyName - Name of the company. * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. */ - getCompanyFavorGain(companyName: CompanyName): number; + getCompanyFavorGain(companyName: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * List all current faction invitations. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * Returns an array with the name of all Factions you currently have oustanding invitations from. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @returns Array with the name of all Factions you currently have oustanding invitations from. */ - checkFactionInvitations(): FactionName[]; + checkFactionInvitations(): string[]; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Join a faction. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically accept an invitation from a faction and join it. * - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to join. * @returns True if player joined the faction, and false otherwise. */ - joinFaction(faction: FactionName): boolean; + joinFaction(faction: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Work for a faction. + * @remarks + * RAM cost: 3 GB + * + * Singularity - Level 2 * * This function will automatically set you to start working for the specified faction. * Obviously, you must be a member of the faction or else this function will fail. If @@ -2001,67 +1453,77 @@ interface Singularity { * } * //This way, your faction reputation will be updated every minute. * ``` - * @remarks RAM cost: 3 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to work for. * @param workType - Type of work to perform for the faction. * @returns True if the player starts working, and false otherwise. */ - workForFaction(faction: FactionName, workType: FactionWork): boolean; + workForFaction(faction: string, workType: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction reputation. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function returns the amount of reputation you have for the specified faction. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction to work for. * @returns Amount of reputation you have for the specified faction. */ - getFactionRep(faction: FactionName): number; + getFactionRep(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction favor. + * @remarks + * RAM cost: 1 GB + * + * Singularity - Level 2 * * This function returns the amount of favor you have for the specified faction. * - * @remarks RAM cost: 1 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction. * @returns Amount of favor you have for the specified faction. */ - getFactionFavor(faction: FactionName): number; + getFactionFavor(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get faction favor gain. + * @remarks + * RAM cost: 0.75 GB + * + * Singularity - Level 2 * * This function returns the amount of favor you will gain for the specified * faction when you reset by installing Augmentations. * - * @remarks RAM cost: 0.75 GB - * @remarks Singularity - Level 2 * @param faction - Name of faction. * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations. */ - getFactionFavorGain(faction: FactionName): number; + getFactionFavorGain(faction: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Donate to a faction. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Attempts to donate money to the specified faction in exchange for reputation. * Returns true if you successfully donate the money, and false otherwise. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction to donate to. * @param amount - Amount of money to donate. * @returns True if the money was donated, and false otherwise. */ - donateToFaction(faction: FactionName, amount: number): boolean; + donateToFaction(faction: string, amount: number): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Create a program. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * 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 @@ -2086,15 +1548,17 @@ interface Singularity { * ```ts * createProgram(“relaysmtp.exe”); * ``` - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param program - Name of program to create. * @returns True if you successfully start working on the specified program, and false otherwise. */ - createProgram(program: Programs): boolean; + createProgram(program: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Commit a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function is used to automatically attempt to commit crimes. * If you are already in the middle of some ‘working’ action (such @@ -2112,168 +1576,176 @@ interface Singularity { * although the game sets a certain crime to be X amount of seconds, there is no * guarantee that your browser will follow that time limit. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime to attempt. * @returns True if you successfully start working on the specified program, and false otherwise. */ - commitCrime(crime: Crime): number; + commitCrime(crime: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get chance to successfully commit a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns your chance of success at commiting the specified crime. - * The chance is returned as a decimal (i.e. 60% would be returned as 0.6). * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime. - * @returns Chance of success at commiting the specified crime as a decimal. + * @returns Chance of success at commiting the specified crime. */ - getCrimeChance(crime: Crime): number; + getCrimeChance(crime: string): number; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get stats related to a crime. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns the stats of the crime. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param crime - Name of crime. Not case-sensitive * @returns The stats of the crime. */ - getCrimeStats(crime: Crime): CrimeStats; + getCrimeStats(crime: string): CrimeStats; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of owned augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns an array containing the names (as strings) of all Augmentations you have. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. * @returns Array containing the names (as strings) of all Augmentations you have. */ - getOwnedAugmentations(purchased?: boolean): AugmentName[]; + getOwnedAugmentations(purchased?: boolean): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of acquired Source-Files. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns an array of source files * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @returns Array containing an object with number and level of the source file. */ getOwnedSourceFiles(): SourceFileLvl[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get a list of augmentation available from a faction. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * Returns an array containing the names (as strings) of all Augmentations * that are available from the specified faction. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction. * @returns Array containing the names of all Augmentations. */ - getAugmentationsFromFaction(faction: FactionName): AugmentName[]; + getAugmentationsFromFaction(faction: string): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the pre-requisite of an augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. * If there are no prerequisites, a blank array is returned. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param augName - Name of Augmentation. * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. */ - getAugmentationPrereq(augName: AugmentName): AugmentName[]; + getAugmentationPrereq(augName: string): string[]; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Purchase an augmentation + * @remarks + * RAM cost: 5 GB * - * This function returns an array with two elements that gives the cost for - * the specified Augmentation. The first element in the returned array is the - * reputation requirement of the Augmentation, and the second element is the - * money cost. - * - * If an invalid Augmentation name is passed in for the augName argument, this - * function will return the array [-1, -1]. - * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 - * @param augName - Name of Augmentation. - * @returns Array with first element as a reputation requirement and second element as the money cost. - */ - getAugmentationCost(augName: AugmentName): [number, number]; - - /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Singularity - Level 3 * * This function will try to purchase the specified Augmentation through the given Faction. * * This function will return true if the Augmentation is successfully purchased, and false otherwise. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param faction - Name of faction to purchase Augmentation from. - * @param augmnet - Name of Augmentation to purchase. + * @param augmentation - Name of Augmentation to purchase. * @returns True if the Augmentation is successfully purchased, and false otherwise. */ - purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; + purchaseAugmentation(faction: string, augmentation: string): boolean; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Get the stats of an augmentation. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function returns augmentation stats. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 * @param name - Name of Augmentation. CASE-SENSITIVE. * @returns Augmentation stats. */ - getAugmentationStats(name: AugmentName): AugmentationStats; + getAugmentationStats(name: string): AugmentationStats; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Install your purchased augmentations. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function will automatically install your Augmentations, resetting the game as usual. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 - * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + * @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; /** - * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * Soft reset the game. + * @remarks + * RAM cost: 5 GB + * + * Singularity - Level 3 * * This function will perform a reset even if you don’t have any augmentation installed. * - * @remarks RAM cost: 5 GB - * @remarks Singularity - Level 3 */ softReset(): void; } /** * Hacknet API + * @remarks + * Not all these functions are immediately available. * @public */ interface Hacknet { /** + * Get the number of hacknet nodes you own. + * @remarks + * RAM cost: 0 GB + * * Returns the number of Hacknet Nodes you own. * - * @remarks RAM cost: 0 GB * @returns number of hacknet nodes. */ numNodes(): 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` @@ -2281,33 +1753,42 @@ interface Hacknet { * * If the player cannot afford to purchase a new Hacknet Node then the function will return -1. * - * @remarks RAM cost: 0 GB * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. */ purchaseNode(): number; /** + * Get the price of the next hacknet node. + * @remarks + * RAM cost: 0 GB + * * Returns the cost of purchasing a new Hacknet Node. * - * @remarks RAM cost: 0 GB * @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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node * @returns Object containing a variety of stats about the specified Hacknet Node. */ getNodeStats(index: number): NodeStats; /** + * 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 @@ -2315,7 +1796,6 @@ interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise. @@ -2323,6 +1803,10 @@ interface Hacknet { 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. @@ -2332,7 +1816,6 @@ interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise. @@ -2340,6 +1823,10 @@ interface Hacknet { 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 @@ -2347,7 +1834,6 @@ interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. @@ -2355,6 +1841,10 @@ interface Hacknet { 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. @@ -2364,7 +1854,6 @@ interface Hacknet { * * Returns false otherwise. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer. * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. @@ -2372,12 +1861,15 @@ interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node. @@ -2385,12 +1877,15 @@ interface Hacknet { 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 is already at max level, then Infinity is returned. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's ram. @@ -2398,12 +1893,15 @@ interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's number of cores. @@ -2411,6 +1909,10 @@ interface Hacknet { 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. @@ -2418,7 +1920,6 @@ interface Hacknet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @remarks RAM cost: 0 GB * @param index - Index/Identifier of Hacknet Node. * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer. * @returns Cost of upgrading the specified Hacknet Node's cache. @@ -2426,16 +1927,23 @@ interface Hacknet { 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. * - * @remarks RAM cost: 0 GB * @returns Number of hashes you have. */ numHashes(): 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. @@ -2447,13 +1955,16 @@ interface Hacknet { * hacknet.spendHashes(upgName); * } * ``` - * @remarks RAM cost: 0 GB * @param upgName - Name of the upgrade of Hacknet Node. * @returns Number of hashes required for the specified upgrade. */ - hashCost(upgName: HashUpgrades): number; + hashCost(upgName: string): 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. @@ -2468,169 +1979,160 @@ interface Hacknet { * hacknet.spendHashes("Sell for Corporation Funds"); * hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); * ``` - * @remarks RAM cost: 0 GB * @param upgName - Name of the upgrade of Hacknet Node. * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. * @returns True if the upgrade is successfully purchased, and false otherwise.. */ - spendHashes(upgName: HashUpgrades, upgTarget?: string): boolean; + spendHashes(upgName: string, upgTarget?: string): boolean; } /** + * 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 interface Bladeburner { /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all contracts. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner contracts. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner contracts. */ - getContractNames(): BladeburnerContracts[]; + getContractNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all operations. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner operations. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner operations. */ - getOperationNames(): BladeburnerOperations[]; + getOperationNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all black ops. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all Bladeburner Black Ops. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all Bladeburner Black Ops. */ - getBlackOpNames(): BladeburnerBlackOps[]; + getBlackOpNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all general actions. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all general Bladeburner actions. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all general Bladeburner actions. */ - getGeneralActionNames(): BladeburnerGenActions[]; + getGeneralActionNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * List all skills. + * @remarks + * RAM cost: 0.4 GB * * Returns an array of strings containing the names of all general Bladeburner skills. * - * @remarks RAM cost: 0.4 GB * @returns Array of strings containing the names of all general Bladeburner skills. */ - getSkillNames(): BladeburnerSkills[]; + getSkillNames(): string[]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match * @returns True if the action was started successfully, and false otherwise. */ - startAction( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; + startAction(type: string, name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Stop current action. + * @remarks + * RAM cost: 2 GB * * Stops the current Bladeburner action. * - * @remarks RAM cost: 2 GB */ stopBladeburnerAction(): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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”. * - * @remarks RAM cost: 1 GB * @returns Object that represents the player’s current Bladeburner action. */ getCurrentAction(): BladeburnerCurAction; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get the time to complete an action. + * @remarks + * RAM cost: 4 GB * * Returns the number of seconds it takes to complete the specified action * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. - * @returns Number of seconds it takes to complete the specified action. + * @returns Number of milliseconds it takes to complete the specified action. */ - getActionTime( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionTime(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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). * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Estimated success chance for the specified action. */ - getActionEstimatedSuccessChance( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionEstimatedSuccessChance(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param level - Optional action level at which to calculate the gain * @returns Average Bladeburner reputation gain for successfully completing the specified action. */ - getActionRepGain( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): number; + getActionRepGain(type: string, name: string, level: number): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get action count remaining. + * @remarks + * RAM cost: 4 GB * * Returns the remaining count of the specified action. * @@ -2639,288 +2141,259 @@ export interface Bladeburner { * This function will return 1 for BlackOps not yet completed regardless of wether * the player has the required rank to attempt the mission or not. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Remaining count of the specified action. */ - getActionCountRemaining( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionCountRemaining(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Maximum level of the specified action. */ - getActionMaxLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionMaxLevel(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Current level of the specified action. */ - getActionCurrentLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getActionCurrentLevel(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get wether 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns True if the action is set to autolevel, and false otherwise. */ - getActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): boolean; + getActionAutolevel(type: string, name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set an action autolevel. + * @remarks + * RAM cost: 4 GB * * Enable/disable autoleveling for the specified action. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param autoLevel - Whether or not to autolevel this action */ - setActionAutolevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - autoLevel: boolean, - ): void; + setActionAutolevel(type: string, name: string, autoLevel: boolean): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set the level of an action. + * @remarks + * RAM cost: 4 GB * * Set the level for the specified action. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param level - Level to set this action to. */ - setActionLevel( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - level: number, - ): void; + setActionLevel(type: string, name: string, level: number): void; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get player bladeburner rank. + * @remarks + * RAM cost: 4 GB * * Returns the player’s Bladeburner Rank. * - * @remarks RAM cost: 4 GB * @returns Player’s Bladeburner Rank. */ getRank(): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 2 GB * @param name - Name of BlackOp. Must be an exact match. * @returns Rank required to complete this BlackOp. */ - getBlackOpRank(name: BladeburnerBlackOps): number; + getBlackOpRank(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get bladeburner skill points. + * @remarks + * RAM cost: 4 GB * * Returns the number of Bladeburner skill points you have. * - * @remarks RAM cost: 4 GB * @returns Number of Bladeburner skill points you have. */ getSkillPoints(): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill. Case-sensitive and must be an exact match * @returns Level in the specified skill. */ - getSkillLevel(name: BladeburnerSkills): number; + getSkillLevel(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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 function returns -1 if an invalid skill name is passed in. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill. Case-sensitive and must be an exact match * @returns Number of skill points needed to upgrade the specified skill. */ - getSkillUpgradeCost(name: BladeburnerSkills): number; + getSkillUpgradeCost(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Upgrade skill. + * @remarks + * RAM cost: 4 GB * * Attempts to upgrade the specified Bladeburner skill. * * Returns true if the skill is successfully upgraded, and false otherwise. * - * @remarks RAM cost: 4 GB * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match * @returns true if the skill is successfully upgraded, and false otherwise. */ - upgradeSkill(name: BladeburnerSkills): boolean; + upgradeSkill(name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @returns Number of Bladeburner team members that were assigned to the specified action. */ - getTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - ): number; + getTeamSize(type: string, name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Set 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. * - * @remarks RAM cost: 4 GB * @param type - Type of action. * @param name - Name of action. Must be an exact match. * @param size - Number of team members to set. Will be converted using Math.round(). * @returns Number of Bladeburner team members you assigned to the specified action. */ - setTeamSize( - type: BladeburnerActTypes, - name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, - size: number, - ): number; + setTeamSize(type: string, name: string, size: number): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Estimated number of Synthoids in the specified city. */ - getCityEstimatedPopulation(name: City): number; + getCityEstimatedPopulation(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Number of Synthoids communities in the specified city. */ - getCityCommunities(name: City): number; + getCityCommunities(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns Chaos in the specified city. */ - getCityChaos(name: City): number; + getCityChaos(name: string): number; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get current city. + * @remarks + * RAM cost: 4 GB * * Returns the city that the player is currently in (for Bladeburner). * - * @remarks RAM cost: 4 GB * @returns City that the player is currently in (for Bladeburner). */ - getCity(): City; + getCity(): string; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * 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 * - * @remarks RAM cost: 4 GB * @param cityName - Name of city. Case-sensitive * @returns true if successful, and false otherwise */ - switchCity(name: City): boolean; + switchCity(name: string): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * Get bladeburner stamina. + * @remarks + * RAM cost: 4 GB * Returns an array with two elements: * * [Current stamina, Max stamina] * @example @@ -2930,29 +2403,28 @@ export interface Bladeburner { * return res[0] / res[1]; * } * ``` - * @remarks RAM cost: 4 GB * @returns Array containing current stamina and max stamina. */ getStamina(): [number, number]; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. - * + * 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. * - * @remarks RAM cost: 4 GB * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. */ joinBladeburnerFaction(): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Join the bladeburner division. + * @remarks + * RAM cost: 4 GB * * Attempts to join the Bladeburner division. * @@ -2960,14 +2432,14 @@ export interface Bladeburner { * * Returns false otherwise. * - * @remarks RAM cost: 4 GB * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. */ joinBladeburnerDivision(): boolean; /** - * You have to be employed in the Bladeburner division and be in BitNode-7 - * or have Source-File 7 in order to use this function. + * Get bladeburner bonus time. + * @remarks + * RAM cost: 0 GB * * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. * @@ -2977,8 +2449,7 @@ export interface Bladeburner { * For example, if an action takes 30 seconds to complete but you’ve accumulated over * 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. * - * @remarks RAM cost: 0 GB - * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + * @returns Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. */ getBonusTime(): number; } @@ -2989,43 +2460,55 @@ export interface Bladeburner { */ interface CodingContract { /** + * Attemps a coding contract. + * @remarks + * RAM cost: 10 GB + * * Attempts to solve the Coding Contract with the provided solution. * - * @remarks 10 GB * @param answer - Solution for the contract. * @param fn - Filename of the contract. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns True if the solution was correct, false otherwise. */ - attempt(answer: string | string[] | number, fn: string, host?: string): boolean; + attempt(answer: string[] | number, fn: string, host?: string): boolean; /** + * Attemps a coding contract. + * @remarks + * RAM cost: 10 GB + * * Attempts to solve the Coding Contract with the provided solution. * - * @remarks 10 GB * @param answer - Solution for the contract. * @param fn - Filename of the contract. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @param opts - Optional parameters for configuring function behavior. * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. */ - attempt(answer: string | string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string; + attempt(answer: string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | 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.) * - * @remarks RAM cost: 5 GB * @param fn - Filename of the contract. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns Name describing the type of problem posed by the Coding Contract. */ - getContractType(fn: string, host?: string): CodingContractTypes; + getContractType(fn: 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. * - * @remarks RAM cost: 5 GB * @param fn - Filename of the contract. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns Contract’s text description. @@ -3033,11 +2516,14 @@ interface CodingContract { getDescription(fn: 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 * - * @remarks RAM cost: 5 GB * @param fn - 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; @@ -3045,9 +2531,12 @@ interface CodingContract { getData(fn: string, host?: string): string; /** + * Get the number of attempt remaining. + * @remarks + * RAM cost: 2 GB + * * Get the number of tries remaining on the contract before it self-destructs. * - * @remarks RAM cost: 2 GB * @param fn - Filename of the contract. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided. * @returns How many attempts are remaining for the contract; @@ -3057,62 +2546,71 @@ interface CodingContract { /** * Gang API + * @remarks + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this API. * @public */ interface Gang { /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * List all gang members. + * @remarks + * RAM cost: 1 GB * * Get the names of all Gang members * - * @remarks RAM cost: 1 GB * @returns Names of all Gang members. */ getMemberNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about your gang. + * @remarks + * RAM cost: 2 GB * * Get general information about the gang. * - * @remarks RAM cost: 2 GB * @returns Object containing general information about the gang. */ getGangInformation(): GangGenInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about the other gangs. + * @remarks + * RAM cost: 2 GB * * Get territory and power information about all gangs. * - * @remarks RAM cost: 2 GB * @returns Object containing territory and power information about all gangs. */ getOtherGangInformation(): GangOtherInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get information about a specific gang member. + * @remarks + * RAM cost: 2 GB * * Get stat and equipment-related information about a Gang Member * - * @remarks RAM cost: 2 GB * @param name - Name of member. * @returns Object containing stat and equipment-related information about a Gang Member. */ getMemberInformation(name: string): GangMemberInfo; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Check if you can recruit a new gang member. + * @remarks + * RAM cost: 1 GB * * Returns boolean indicating whether a member can currently be recruited * - * @remarks RAM cost: 1 GB * @returns True if a member can currently be recruited, false otherwise. */ canRecruitMember(): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Recruit a new gang member. + * @remarks + * RAM cost: 2 GB * * Attempt to recruit a new gang member. * @@ -3120,137 +2618,149 @@ interface Gang { * * Cannot currently recruit a new member * * There already exists a member with the specified name * - * @remarks RAM cost: 2 GB * @param name - Name of member to recruit. * @returns True if the member was successfully recruited, false otherwise. */ recruitMember(name: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * List member task names. + * @remarks + * RAM cost: 1 GB * * Get the name of all valid tasks that Gang members can be assigned to. * - * @remarks RAM cost: 1 GB * @returns All valid tasks that Gang members can be assigned to. */ - getTaskNames(): GangTasks[]; + getTaskNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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”). * - * @remarks RAM cost: 2 GB * @param memberName - Name of Gang member to assign. * @param taskName - Task to assign. * @returns True if the Gang Member was successfully assigned to the task, false otherwise. */ - setMemberTask(memberName: string, taskName: GangTasks): boolean; + setMemberTask(memberName: string, taskName: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 1 GB * @param name - Name of the task. * @returns Detailed stats of a task. */ - getTaskStats(name: GangTasks): GangTasksStats; + getTaskStats(name: string): stringStats; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 1 GB * @returns Names of all Equpiment/Augmentations. */ - getEquipmentNames(): (GangEquipment | GangAugmentations)[]; + getEquipmentNames(): string[]; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments */ - getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; + getEquipmentCost(equipName: string): number; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get type of an equipment. + * @remarks + * RAM cost: 2 GB * * Get the specified equipment type. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns Type of the equipment. */ - getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; + getEquipmentType(equipName: string): string; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get stats of an equipment. + * @remarks + * RAM cost: 2 GB * * Get the specified equipment stats. * - * @remarks RAM cost: 2 GB * @param equipName - Name of equipment. * @returns A dictionary containing the stats of the equipment. */ - getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; + getEquipmentStats(equipName: string): stringStats; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Purchase an equipment for a gang member. + * @remarks + * RAM cost: 4 GB * * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. * - * @remarks RAM cost: 4 GB * @param memberName - Name of Gang member to purchase the equipment for. * @param equipName - Name of Equipment/Augmentation to purchase. * @returns True if the equipment was successfully purchased. False otherwise */ - purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; + purchaseEquipment(memberName: string, equipName: string): boolean; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Ascend a gang member. + * @remarks + * RAM cost: 4 GB * * Ascend the specified Gang Member. * - * @remarks RAM cost: 4 GB * @param memberName - Name of member to ascend. * @returns Object with info about the ascension results. */ ascendMember(memberName: string): GangMemberAscension; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Enable/Disable territory warfare. + * @remarks + * RAM cost: 2 GB * * Set whether or not the gang should engage in territory warfare * - * @remarks RAM cost: 2 GB * @param engage - Whether or not to engage in territory warfare. */ setTerritoryWarfare(engage: boolean): void; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * 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 * - * @remarks RAM cost: 4 GB * @param gangName - Target gang * @returns Chance you have to win a clash with the specified gang. */ - getChanceToWinClash(gangName: GangName): number; + getChanceToWinClash(gangName: string): number; /** - * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * Get bonus time. + * @remarks + * RAM cost: 0 GB * * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. * @@ -3258,192 +2768,208 @@ interface Gang { * * “Bonus time” makes the game progress faster, up to 10x the normal speed. * - * @remarks RAM cost: 0 GB - * @returns Bonus time for the Gang mechanic in seconds. + * @returns Bonus time for the Gang mechanic in milliseconds. */ getBonusTime(): 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 */ interface Sleeve { /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get the number of sleeves you own. + * @remarks + * RAM cost: 4 GB * * Return the number of duplicate sleeves the player has. * - * @remarks RAM cost: 4 GB * @returns number of duplicate sleeves the player has. */ getNumSleeves(): number; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get the stats of a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a structure containing the stats of the sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to get stats of. * @returns Object containing the stats of the sleeve. */ getSleeveStats(sleeveNumber: number): SleeveSkills; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get information about a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a struct containing tons of information about this sleeve * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve information. * @returns Object containing tons of information about this sleeve. */ getInformation(sleeveNumber: number): SleeveInformation; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get task of a sleeve. + * @remarks + * RAM cost: 4 GB * * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve task from. * @returns Object containing information the current task that the sleeve is performing. */ getTask(sleeveNumber: number): SleeveTask; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to shock recovery. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start recovery. * @returns True if this action was set successfully, false otherwise. */ setToShockRecovery(sleeveNumber: number): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to synchronize. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start synchronizing. * @returns True if this action was set successfully, false otherwise. */ setToSynchronize(sleeveNumber: number): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Set a sleeve to commit crime. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not this action was set successfully. * * Returns false if an invalid action is specified. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start commiting crime. * @param name - Name of the crime. Must be an exact match. * @returns True if this action was set successfully, false otherwise. */ - setToCommitCrime(sleeveNumber: number, name: Crime): boolean; + setToCommitCrime(sleeveNumber: number, name: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to work for the faction. * @param factionName - Name of the faction to work for. * @param factionWorkType - Name of the action to perform for this faction. * @returns True if the sleeve started working on this faction, false otherwise. */ - setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; + setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to work for the company. * @param companyName - Name of the company to work for. * @returns True if the sleeve started working on this company, false otherwise. */ - setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; + setToCompanyWork(sleeveNumber: number, companyName: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to start taking class. * @param university - Name of the university to attend. * @param className - Name of the class to follow. * @returns True if this action was set successfully, false otherwise. */ - setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; + setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * 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. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to workout at the gym. * @param gymName - Name of the gym. * @param stat - Name of the stat to train. * @returns True if the sleeve started working out, false otherwise. */ - setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; + setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Make a sleeve travel to another city. + * @remarks + * RAM cost: 4 GB * * Return a boolean indicating whether or not the sleeve reached destination. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to travel. * @param cityName - Name of the destination city. * @returns True if the sleeve reached destination, false otherwise. */ - travel(sleeveNumber: number, cityName: City): boolean; + travel(sleeveNumber: number, cityName: string): boolean; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Get augmentations installed on a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a list of augmentation names that this sleeve has installed. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve augmentations from. * @returns List of augmentation names that this sleeve has installed. */ - getSleeveAugmentations(sleeveNumber: number): AugmentName[]; + getSleeveAugmentations(sleeveNumber: number): string[]; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * List purchasable augs for a sleeve. + * @remarks + * RAM cost: 4 GB * * Return a list of augmentations that the player can buy for this sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from. * @returns List of augmentations that the player can buy for this sleeve. */ getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; /** - * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * Purchase an aug for a sleeve. + * @remarks + * RAM cost: 4 GB * * Return true if the aug was purchased and installed on the sleeve. * - * @remarks RAM cost: 4 GB * @param sleeveNumber - Index of the sleeve to buy an aug for. * @param augName - Name of the aug to buy. Must be an exact match. * @returns True if the aug was purchased and installed on the sleeve, false otherwise. */ - purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; + purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; } /** @@ -3453,14 +2979,7 @@ interface Sleeve { export interface NS extends Singularity { /** * Namespace for hacknet related functions. - * @remarks - * Not all functions in the Hacknet Node API are immediately available. - * - * Note that none of these functions will write to the script’s logs. - * - * If you want to see what your script is doing you will have to print to the logs yourself. - * - * 4 GB + * @remarks RAM cost: 4 GB */ readonly hacknet: Hacknet; /** @@ -4070,7 +3589,7 @@ export interface NS extends Singularity { * @param destination - Host of the destination server, which is the server to which the file will be copied. * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ - scp(files: string | string[], destination: string): boolean; + scp(files: string[], destination: string): boolean; /** * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string @@ -4094,7 +3613,7 @@ export interface NS extends Singularity { * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ scp( - files: string | string[], + files: string[], source: string, // tslint:disable-next-line:unified-signatures destination: string, @@ -4424,7 +3943,7 @@ export interface NS extends Singularity { * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). * @returns The hostname of the newly purchased server. */ - purchaseServer(hostname: string, ram: number): string | ""; + purchaseServer(hostname: string, ram: number): string; /** * Deletes one of your purchased servers, which is specified by its hostname. @@ -4484,7 +4003,7 @@ export interface NS extends Singularity { * @param data - Data to write. * @param mode - Defines the write mode. Only valid when writing to text files. */ - write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; + write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void; /** * Attempts to write data to the specified Netscript Port. @@ -4496,7 +4015,7 @@ export interface NS extends Singularity { * @param data - Data to write. * @returns True if the data is successfully written to the port, and false otherwise. */ - tryWrite(port: Handle, data: string | string[] | number): boolean; + tryWrite(port: Handle, data: string[] | number): boolean; /** * This function is used to read data from a port or from a text file (.txt). @@ -4547,7 +4066,7 @@ export interface NS extends Singularity { * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. * * @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports - * @remarks 10 GB + * @remarks RAM cost: 10 GB * @param port - Port number. Must be an integer between 1 and 20. * @returns Data in the specified port. */