diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 08176beca..4dc51389c 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -146,6 +146,8 @@ export declare interface BitNodeMultipliers { FourSigmaMarketDataApiCost: number; /** Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) */ FourSigmaMarketDataCost: number; + /** Influences the respect gain and money gain of your gang. */ + GangSoftcap: number; /** Influences the experienced gained when hacking a server. */ HackExpGain: number; /** Influences how quickly the player's hacking level (not experience) scales */ @@ -166,10 +168,14 @@ export declare interface BitNodeMultipliers { PurchasedServerLimit: number; /** Influences the maximum allowed RAM for a purchased server */ PurchasedServerMaxRam: number; + /** Influences cost of any purchased server at or above 128GB */ + PurchasedServerSoftCap: number; /** Influences the minimum favor the player must have with a faction before they can donate to gain rep. */ RepToDonateToFaction: number; - /** Influences how much money can be stolen from a server when a script performs a hack against it. */ + /** Influences how much the money on a server can be reduced when a script performs a hack against it. */ ScriptHackMoney: number; + /** Influences how much of the money stolen by a scripted hack will be added to the player's money. */ + ScriptHackMoneyGain: number; /** Influences the growth percentage per cycle against a server. */ ServerGrowthRate: number; /** Influences the maxmimum money that a server can grow to. */ @@ -182,6 +188,12 @@ export declare interface BitNodeMultipliers { ServerWeakenRate: number; /** Influences how quickly the player's strength level (not exp) scales */ StrengthLevelMultiplier: number; + /** Influences the power of the gift */ + StaneksGiftPowerMultiplier: number; + /** Influences the size of the gift */ + StaneksGiftExtraSize: number; + /** Influences the hacking skill required to backdoor the world daemon. */ + WorldDaemonDifficulty: number; } /** @@ -1046,6 +1058,11 @@ export declare interface EquipmentStats { hack?: number; } +/** + * @public + */ +export declare type FilenameOrPID = number | string; + /** * Formulas API * @remarks @@ -2009,6 +2026,37 @@ export declare interface HacknetMultipliers { levelCost: number; } +/** + * Hacknet node related constants + * @public + */ +export declare interface HacknetNodeConstants { + /** Amount of money gained per level */ + MoneyGainPerLevel: number; + /** Base cost for a new node */ + BaseCost: number; + /** Base cost per level */ + LevelBaseCost: number; + /** Base cost to incrase RAM */ + RamBaseCost: number; + /** Base cost to increase cores */ + CoreBaseCost: number; + /** Multiplier to purchase new node */ + PurchaseNextMult: number; + /** Multiplier to increase node level */ + UpgradeLevelMult: number; + /** Multiplier to increase RAM */ + UpgradeRamMult: number; + /** Multiplier to increase cores */ + UpgradeCoreMult: number; + /** Max node level */ + MaxLevel: number; + /** Max amount of RAM in GB */ + MaxRam: number; + /** Max number of cores */ + MaxCores: number; +} + /** * Hacknet Node formulas * @public @@ -2058,7 +2106,44 @@ export declare interface HacknetNodesFormulas { * All constants used by the game. * @returns An object with all hacknet node constants used by the game. */ - constants(): number; + constants(): HacknetNodeConstants; +} + +/** + * Hacknet server related constants + * @public + */ +export declare interface HacknetServerConstants { + /** Number of hashes calculated per level */ + HashesPerLevel: number; + /** Base cost for a new server */ + BaseCost: number; + /** Base cost to increase RAM */ + RamBaseCost: number; + /** Base cost to increase cores */ + CoreBaseCost: number; + /** Base cost to upgrade cache */ + CacheBaseCost: number; + /** Multiplier to purchase a new server */ + PurchaseMult: number; + /** Multiplier to increase server level */ + UpgradeLevelMult: number; + /** Multiplier to increase RAM */ + UpgradeRamMult: number; + /** Multiplier to increase cores */ + UpgradeCoreMult: number; + /** Multiplier to upgrade cache */ + UpgradeCacheMult: number; + /** Max number of servers */ + MaxServers: number; + /** Max level for a server */ + MaxLevel: number; + /** Max amount of RAM in GB */ + MaxRam: number; + /** Max number of cores */ + MaxCores: number; + /** Max cache size */ + MaxCache: number; } /** @@ -2125,7 +2210,16 @@ export declare interface HacknetServersFormulas { * All constants used by the game. * @returns An object with all hacknet server constants used by the game. */ - constants(): any; + constants(): HacknetServerConstants; +} + +/** + * Interface Styles + * @internal + */ +export declare interface IStyleSettings { + fontFamily: string; + lineHeight: number; } /** @@ -2141,6 +2235,78 @@ export declare interface Material { qlt: number; } +/** + * Object representing a port. A port is a serialized queue. + * @public + */ +export declare interface NetscriptPort { + /** + * Write data to a port. + * @remarks + * RAM cost: 0 GB + * + * @returns The data popped off the queue if it was full. + */ + write(value: string | number): null | string | number; + + /** + * Attempt to write data to the port. + * @remarks + * RAM cost: 0 GB + * + * @returns True if the data was added to the port, false if the port was full + */ + tryWrite(value: string | number): boolean; + + /** + * Shift an element out of the port. + * @remarks + * RAM cost: 0 GB + * + * This function will remove the first element from the port and return it. + * If the port is empty, then the string “NULL PORT DATA” will be returned. + * @returns the data read. + */ + read(): string | number; + + /** + * Retrieve the first element from the port without removing it. + * @remarks + * RAM cost: 0 GB + * + * This function is used to peek at the data from a port. It returns the + * first element in the specified port without removing that element. If + * the port is empty, the string “NULL PORT DATA” will be returned. + * @returns the data read + */ + peek(): string | number; + + /** + * Check if the port is full. + * @remarks + * RAM cost: 0 GB + * + * @returns true if the port is full, otherwise false + */ + full(): boolean; + + /** + * Check if the port is empty. + * @remarks + * RAM cost: 0 GB + * + * @returns true if the port is empty, otherwise false + */ + empty(): boolean; + + /** + * Empties all data from the port. + * @remarks + * RAM cost: 0 GB + */ + clear(): void; +} + /** * Object representing all the values related to a hacknet node. * @public @@ -2150,9 +2316,9 @@ export declare interface NodeStats { name: string; /** Node's level */ level: number; - /** Node's RAM */ + /** Node's RAM (GB) */ ram: number; - /** Node's used RAM */ + /** Node's used RAM (GB) */ ramUsed: number; /** Node's number of cores */ cores: number; @@ -2696,11 +2862,11 @@ export declare interface NS extends Singularity { * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] * ns.tail("foo.script", "foodnstuff", 1, "test"); * ``` - * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed. + * @param fn - Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. * @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. * @param args - Arguments for the script being tailed. */ - tail(fn?: string, host?: string, ...args: any[]): void; + tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; /** * Get the list of servers connected to a server. @@ -3075,6 +3241,7 @@ export declare 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): Promise; scp(files: string | string[], source: string, destination: string): Promise; /** @@ -3350,7 +3517,7 @@ export declare interface NS extends Singularity { * const [totalRam, ramUsed] = ns.getServerRam("helios"); * ``` * @param host - Host of target server. - * @returns Array with total and used memory on the specified server. + * @returns Array with total and used memory on the specified server, in GB. */ getServerRam(host: string): [number, number]; @@ -3360,7 +3527,7 @@ export declare interface NS extends Singularity { * RAM cost: 0.05 GB * * @param host - Hostname of the target server. - * @returns max ram + * @returns max ram (GB) */ getServerMaxRam(host: string): number; /** @@ -3369,7 +3536,7 @@ export declare interface NS extends Singularity { * RAM cost: 0.05 GB * * @param host - Hostname of the target server. - * @returns used ram + * @returns used ram (GB) */ getServerUsedRam(host: string): number; @@ -3443,6 +3610,7 @@ export declare interface NS extends Singularity { * RAM cost: 0.1 GB * * Returns a boolean indicating whether the specified script is running on the target server. + * If you use a PID instead of a filename, the hostname and args parameters are unnecessary. * Remember that a script is uniquely identified by both its name and its arguments. * * @example @@ -3469,12 +3637,12 @@ export declare interface NS extends Singularity { * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: * ns.isRunning("foo.script", "joesguns", 1, 5, "test"); * ``` - * @param script - Filename of script to check. This is case-sensitive. + * @param script - Filename or PID of script to check. This is case-sensitive. * @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. */ - isRunning(script: string, host: string, ...args: string[]): boolean; + isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; /** * Get general info about a running script. @@ -3482,10 +3650,14 @@ export declare interface NS extends Singularity { * RAM cost: 0.3 GB * * Running with no args returns curent script. + * If you use a PID as the first parameter, the hostname and args parameters are unnecessary. * + * @param filename - Optional. Filename or PID of the script. + * @param hostname - Optional. Name of host server the script is running on. + * @param args - Arguments to identify the script * @returns info about a running script */ - getRunningScript(filename?: string | number, hostname?: string, ...args: (string | number)[]): RunningScript; + getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript; /** * Get cost of purchasing a server. @@ -3508,7 +3680,7 @@ export declare interface NS extends Singularity { * ns.tprint(i + " -- " + ns.getPurchasedServerCost(Math.pow(2, i))); * } * ``` - * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @param ram - Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). * @returns The cost to purchase a server with the specified amount of ram. */ getPurchasedServerCost(ram: number): number; @@ -3556,7 +3728,7 @@ export declare interface NS extends Singularity { * } * ``` * @param hostname - Host of the purchased server. - * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). * @returns The hostname of the newly purchased server. */ purchaseServer(hostname: string, ram: number): string; @@ -3597,7 +3769,7 @@ export declare interface NS extends Singularity { * Returns the maximum RAM that a purchased server can have. * * @remarks RAM cost: 0.05 GB - * @returns Returns the maximum RAM that a purchased server can have. + * @returns Returns the maximum RAM (in GB) that a purchased server can have. */ getPurchasedServerMaxRam(): number; @@ -3606,7 +3778,7 @@ export declare interface NS extends Singularity { * @remarks * RAM cost: 0 GB * - * This function can be used to either write data to a text file (.txt). + * This function can be used to write data to a text file (.txt). * * 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 @@ -3615,7 +3787,7 @@ export declare interface NS extends Singularity { * then the data will be written in “append” mode which means that the data will be added at the * end of the text file. * - * @param handle - Port or text file that will be written to. + * @param handle - Filename of the text file that will be written to. * @param data - Data to write. * @param mode - Defines the write mode. Only valid when writing to text files. */ @@ -3641,13 +3813,13 @@ export declare interface NS extends Singularity { * @remarks * RAM cost: 0 GB * - * This function is used to read data from a port or from a text file (.txt). + * This function is used to read data from a text file (.txt). * * This function will return the data in the specified text * file. If the text file does not exist, an empty string will be returned. * - * @param handle - Port or text file to read from. - * @returns Data in the specified text file or port. + * @param handle - Filename to read from. + * @returns Data in the specified text file. */ read(handle: string): any; @@ -3719,9 +3891,8 @@ export declare interface NS extends Singularity { * * @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports * @param port - Port number. Must be an integer between 1 and 20. - * @returns Data in the specified port. */ - getPortHandle(port: number): any[]; + getPortHandle(port: number): NetscriptPort; /** * Delete a file. @@ -3804,7 +3975,7 @@ export declare interface NS extends Singularity { * * @param script - Filename of script. This is case-sensitive. * @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. + * @returns Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist. */ getScriptRam(script: string, host?: string): number; @@ -3848,7 +4019,7 @@ export declare interface NS extends Singularity { * @param host - Host of target server. * @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. */ - getWeakenTime(host?: string): number; + getWeakenTime(host: string): number; /** * Get the income of a script. @@ -4112,7 +4283,7 @@ export declare interface NS extends Singularity { * to convert from script to text file, or vice versa. * * This function can also be used to rename files. - * + * * @param host - Host of target server. * @param source - Filename of the source file. * @param destination - Filename of the destination file. @@ -4262,6 +4433,16 @@ export declare interface OfficeAPI { getEmployee(divisionName: string, cityName: string, employeeName: string): Employee; } +/** + * @public + */ +export declare enum OrderTypes { + LimitBuy = "Limit Buy Order", + LimitSell = "Limit Sell Order", + StopBuy = "Stop Buy Order", + StopSell = "Stop Sell Order", +} + /** * @public */ @@ -4375,6 +4556,14 @@ export declare interface PlayerSkills { intelligence: number; } +/** + * @public + */ +export declare enum PositionTypes { + Long = "L", + Short = "S", +} + /** * A single process on a server. * @public @@ -4519,15 +4708,15 @@ export declare interface Server { /** * Singularity API * @remarks - * This API requires Source-File 4 level 1 / 2 / 3 to use. + * This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels. * @public */ export declare interface Singularity { /** - * SF4.1 - Take university class. + * Take university class. * * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * This function will automatically set you to start taking a course at a university. @@ -4546,10 +4735,10 @@ export declare interface Singularity { universityCourse(universityName: string, courseName: string, focus?: boolean): boolean; /** - * SF4.1 - Workout at the gym. + * Workout at the gym. * * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * This function will automatically set you to start working out at a gym to train @@ -4568,9 +4757,9 @@ export declare interface Singularity { gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; /** - * SF4.1 - Travel to another city. + * Travel to another city. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * This function allows the player to travel to any city. The cost for using this @@ -4582,9 +4771,9 @@ export declare interface Singularity { travelToCity(city: string): boolean; /** - * SF4.1 - Purchase the TOR router. + * Purchase the TOR router. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * This function allows you to automatically purchase a TOR router. The cost for @@ -4596,9 +4785,9 @@ export declare interface Singularity { purchaseTor(): boolean; /** - * SF4.1 - Purchase a program from the dark web. + * Purchase a program from the dark web. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * This function allows you to automatically purchase programs. You MUST have a @@ -4622,9 +4811,9 @@ export declare interface Singularity { purchaseProgram(programName: string): boolean; /** - * SF4.1 - Check if the player is busy. + * Check if the player is busy. * @remarks - * RAM cost: 0.5 GB + * RAM cost: 0.5 GB * 16/4/1 * * * Returns a boolean indicating whether or not the player is currently performing an @@ -4636,9 +4825,9 @@ export declare interface Singularity { isBusy(): boolean; /** - * SF4.1 - Stop the current action. + * Stop the current action. * @remarks - * RAM cost: 1 GB + * RAM cost: 1 GB * 16/4/1 * * * This function is used to end whatever ‘action’ the player is currently performing. @@ -4659,9 +4848,9 @@ export declare interface Singularity { stopAction(): boolean; /** - * SF4.2 - Upgrade home computer RAM. + * Upgrade home computer RAM. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will upgrade amount of RAM on the player’s home computer. The cost is @@ -4674,9 +4863,9 @@ export declare interface Singularity { upgradeHomeRam(): boolean; /** - * SF4.2 - Upgrade home computer cores. + * Upgrade home computer cores. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will upgrade amount of cores on the player’s home computer. The cost is @@ -4689,9 +4878,9 @@ export declare interface Singularity { upgradeHomeCores(): boolean; /** - * SF4.2 - Get the price of upgrading home RAM. + * Get the price of upgrading home RAM. * @remarks - * RAM cost: 1.5 GB + * RAM cost: 1.5 GB * 16/4/1 * * * Returns the cost of upgrading the player’s home computer RAM. @@ -4701,9 +4890,9 @@ export declare interface Singularity { getUpgradeHomeRamCost(): number; /** - * SF4.2 - Get the price of upgrading home cores. + * Get the price of upgrading home cores. * @remarks - * RAM cost: 1.5 GB + * RAM cost: 1.5 GB * 16/4/1 * * * Returns the cost of upgrading the player’s home computer cores. @@ -4713,9 +4902,9 @@ export declare interface Singularity { getUpgradeHomeCoresCost(): number; /** - * SF4.2 - Work for a company. + * Work for a company. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will automatically set you to start working at the company @@ -4755,9 +4944,9 @@ export declare interface Singularity { workForCompany(companyName?: string, focus?: boolean): boolean; /** - * SF4.2 - Apply for a job at a company. + * Apply for a job at a company. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will automatically try to apply to the specified company @@ -4776,9 +4965,9 @@ export declare interface Singularity { applyToCompany(companyName: string, field: string): boolean; /** - * SF4.2 - Get company reputation. + * Get company reputation. * @remarks - * RAM cost: 1 GB + * RAM cost: 1 GB * 16/4/1 * * * This function will return the amount of reputation you have at the specified company. @@ -4790,9 +4979,9 @@ export declare interface Singularity { getCompanyRep(companyName: string): number; /** - * SF4.2 - Get company favor. + * Get company favor. * @remarks - * RAM cost: 1 GB + * RAM cost: 1 GB * 16/4/1 * * * This function will return the amount of favor you have at the specified company. @@ -4804,9 +4993,9 @@ export declare interface Singularity { getCompanyFavor(companyName: string): number; /** - * SF4.2 - Get company favor gain. + * Get company favor gain. * @remarks - * RAM cost: 0.75 GB + * RAM cost: 0.75 GB * 16/4/1 * * * This function will return the amount of favor you will gain for the specified @@ -4818,9 +5007,9 @@ export declare interface Singularity { getCompanyFavorGain(companyName: string): number; /** - * SF4.2 - List all current faction invitations. + * List all current faction invitations. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * Returns an array with the name of all Factions you currently have oustanding invitations from. @@ -4830,9 +5019,9 @@ export declare interface Singularity { checkFactionInvitations(): string[]; /** - * SF4.2 - Join a faction. + * Join a faction. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will automatically accept an invitation from a faction and join it. @@ -4843,9 +5032,9 @@ export declare interface Singularity { joinFaction(faction: string): boolean; /** - * SF4.2 - Work for a faction. + * Work for a faction. * @remarks - * RAM cost: 3 GB + * RAM cost: 3 GB * 16/4/1 * * * This function will automatically set you to start working for the specified faction. @@ -4886,9 +5075,9 @@ export declare interface Singularity { workForFaction(faction: string, workType: string, focus?: boolean): boolean; /** - * SF4.2 - Get faction reputation. + * Get faction reputation. * @remarks - * RAM cost: 1 GB + * RAM cost: 1 GB * 16/4/1 * * * This function returns the amount of reputation you have for the specified faction. @@ -4899,9 +5088,9 @@ export declare interface Singularity { getFactionRep(faction: string): number; /** - * SF4.2 - Get faction favor. + * Get faction favor. * @remarks - * RAM cost: 1 GB + * RAM cost: 1 GB * 16/4/1 * * * This function returns the amount of favor you have for the specified faction. @@ -4912,9 +5101,9 @@ export declare interface Singularity { getFactionFavor(faction: string): number; /** - * SF4.2 - Get faction favor gain. + * Get faction favor gain. * @remarks - * RAM cost: 0.75 GB + * RAM cost: 0.75 GB * 16/4/1 * * * This function returns the amount of favor you will gain for the specified @@ -4926,9 +5115,9 @@ export declare interface Singularity { getFactionFavorGain(faction: string): number; /** - * SF4.3 - Donate to a faction. + * Donate to a faction. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * Attempts to donate money to the specified faction in exchange for reputation. @@ -4941,9 +5130,9 @@ export declare interface Singularity { donateToFaction(faction: string, amount: number): boolean; /** - * SF4.3 - Create a program. + * Create a program. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function will automatically set you to start working on creating the @@ -4982,9 +5171,9 @@ export declare interface Singularity { createProgram(program: string, focus?: boolean): boolean; /** - * SF4.3 - Commit a crime. + * Commit a crime. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function is used to automatically attempt to commit crimes. @@ -5004,14 +5193,14 @@ export declare interface Singularity { * guarantee that your browser will follow that time limit. * * @param crime - Name of crime to attempt. - * @returns True if you successfully start working on the specified program, and false otherwise. + * @returns The number of milliseconds it takes to attempt the specified crime. */ commitCrime(crime: string): number; /** - * SF4.3 - Get chance to successfully commit a crime. + * Get chance to successfully commit a crime. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function returns your chance of success at commiting the specified crime. @@ -5022,9 +5211,9 @@ export declare interface Singularity { getCrimeChance(crime: string): number; /** - * SF4.3 - Get stats related to a crime. + * Get stats related to a crime. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * Returns the stats of the crime. @@ -5035,9 +5224,9 @@ export declare interface Singularity { getCrimeStats(crime: string): CrimeStats; /** - * SF4.3 - Get a list of owned augmentation. + * Get a list of owned augmentation. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function returns an array containing the names (as strings) of all Augmentations you have. @@ -5048,9 +5237,9 @@ export declare interface Singularity { getOwnedAugmentations(purchased?: boolean): string[]; /** - * SF4.3 - Get a list of augmentation available from a faction. + * Get a list of augmentation available from a faction. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * Returns an array containing the names (as strings) of all Augmentations @@ -5062,9 +5251,9 @@ export declare interface Singularity { getAugmentationsFromFaction(faction: string): string[]; /** - * SF4.3 - Get the pre-requisite of an augmentation. + * Get the pre-requisite of an augmentation. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. @@ -5076,10 +5265,10 @@ export declare interface Singularity { getAugmentationPrereq(augName: string): string[]; /** - * SF4.3 - Get the price and reputation of an augmentation. + * Get the price and reputation of an augmentation. * @deprecated use getAugmentationPrice getAugmentationRepCost * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function returns an array with two elements that gives the cost for @@ -5096,9 +5285,9 @@ export declare interface Singularity { getAugmentationCost(augName: string): [number, number]; /** - * SF4.3 - Get price of an augmentation. + * Get price of an augmentation. * @remarks - * RAM cost: 2.5 GB + * RAM cost: 2.5 GB * 16/4/1 * * * @param augName - Name of Augmentation. @@ -5107,9 +5296,9 @@ export declare interface Singularity { getAugmentationPrice(augName: string): number; /** - * SF4.3 - Get reputation requirement of an augmentation. + * Get reputation requirement of an augmentation. * @remarks - * RAM cost: 2.5 GB + * RAM cost: 2.5 GB * 16/4/1 * * * @param augName - Name of Augmentation. @@ -5118,9 +5307,9 @@ export declare interface Singularity { getAugmentationRepReq(augName: string): number; /** - * SF4.3 - Purchase an augmentation + * Purchase an augmentation * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function will try to purchase the specified Augmentation through the given Faction. @@ -5134,9 +5323,9 @@ export declare interface Singularity { purchaseAugmentation(faction: string, augmentation: string): boolean; /** - * SF4.3 - Get the stats of an augmentation. + * Get the stats of an augmentation. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function returns augmentation stats. @@ -5147,9 +5336,9 @@ export declare interface Singularity { getAugmentationStats(name: string): AugmentationStats; /** - * SF4.3 - Install your purchased augmentations. + * Install your purchased augmentations. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function will automatically install your Augmentations, resetting the game as usual. @@ -5159,11 +5348,11 @@ export declare interface Singularity { installAugmentations(cbScript?: string): void; /** - * SF4.1 - Returns an object with the Player’s stats. + * Returns an object with the Player’s stats. * @deprecated use getPlayer * * @remarks - * RAM cost: 0.5 GB + * RAM cost: 0.5 GB * 16/4/1 * * * @example @@ -5176,11 +5365,11 @@ export declare interface Singularity { getStats(): PlayerSkills; /** - * SF4.1 - Returns an object with various information about your character. + * Returns an object with various information about your character. * @deprecated use getPlayer * * @remarks - * RAM cost: 0.5 GB + * RAM cost: 0.5 GB * 16/4/1 * * * @returns Object with various information about your character. @@ -5188,9 +5377,9 @@ export declare interface Singularity { getCharacterInformation(): CharacterInfo; /** - * SF4.1 - Hospitalize the player. + * Hospitalize the player. * @remarks - * RAM cost: 0.25 GB + * RAM cost: 0.25 GB * 16/4/1 * * * @returns The cost of the hospitalization. @@ -5198,9 +5387,9 @@ export declare interface Singularity { hospitalize(): number; /** - * SF4.3 - Soft reset the game. + * Soft reset the game. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * This function will perform a reset even if you don’t have any augmentation installed. @@ -5210,9 +5399,9 @@ export declare interface Singularity { softReset(cbScript: string): void; /** - * SF4.3 - Go to a location. + * Go to a location. * @remarks - * RAM cost: 5 GB + * RAM cost: 5 GB * 16/4/1 * * * Move the player to a specific location. @@ -5223,9 +5412,9 @@ export declare interface Singularity { goToLocation(locationName: string): boolean; /** - * SF4.1 - Get the current server. + * Get the current server. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * @returns Name of the current server. @@ -5233,9 +5422,9 @@ export declare interface Singularity { getCurrentServer(): string; /** - * SF4.1 - Connect to a server. + * Connect to a server. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * Run the connect HOSTNAME command in the terminal. Can only connect to neighbors. @@ -5245,9 +5434,9 @@ export declare interface Singularity { connect(hostname: string): boolean; /** - * SF4.1 - Run the hack command in the terminal. + * Run the hack command in the terminal. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * * @returns Amount of money stolen by manual hacking. @@ -5255,19 +5444,19 @@ export declare interface Singularity { manualHack(): Promise; /** - * SF4.1 - Run the backdoor command in the terminal. + * Run the backdoor command in the terminal. * @remarks - * RAM cost: 2 GB + * RAM cost: 2 GB * 16/4/1 * * - * @returns True if the installation was successful. + * @returns Promise waiting for the installation to finish. */ installBackdoor(): Promise; /** - * SF4.2 - Check if the player is focused. + * Check if the player is focused. * @remarks - * RAM cost: 0.1 GB + * RAM cost: 0.1 GB * 16/4/1 * * * @returns True if the player is focused. @@ -5275,9 +5464,9 @@ export declare interface Singularity { isFocused(): boolean; /** - * SF4.2 - Set the players focus. + * Set the players focus. * @remarks - * RAM cost: 0.1 GB + * RAM cost: 0.1 GB * 16/4/1 * * @returns True if the focus was changed. */ @@ -5709,10 +5898,11 @@ export declare interface Stanek { /** * Return value of {@link TIX.getOrders | getOrders} + * + * Keys are stock symbols, properties are arrays of {@link StockOrderObject} * @public */ export declare interface StockOrder { - /** Stock Symbol */ [key: string]: StockOrderObject[]; } @@ -5726,9 +5916,9 @@ export declare interface StockOrderObject { /** Price per share */ price: number; /** Order type */ - type: string; + type: OrderTypes; /** Order position */ - position: string; + position: PositionTypes; } /** @@ -5988,6 +6178,8 @@ export declare interface TIX { * @remarks * RAM cost: 2.5 GB * This is an object containing information for all the Limit and Stop Orders you have in the stock market. + * For each symbol you have a position in, the returned object will have a key with that symbol's name. + * The object's properties are each an array of {@link StockOrderObject} * The object has the following structure: * * ```ts @@ -6126,6 +6318,36 @@ export declare interface UserInterface { * RAM cost: cost: 0 GB */ resetTheme(): void; + + /** + * Get the current styles + * @remarks + * RAM cost: cost: 0 GB + * + * @returns An object containing the player's styles + */ + getStyles(): IStyleSettings; + + /** + * Sets the current styles + * @remarks + * RAM cost: cost: 0 GB + * @example + * Usage example (NS2) + * ```ts + * const styles = ns.ui.getStyles(); + * styles.fontFamily = 'Comic Sans Ms'; + * ns.ui.setStyles(styles); + * ``` + */ + setStyles(newStyles: IStyleSettings): void; + + /** + * Resets the player's styles to the default values + * @remarks + * RAM cost: cost: 0 GB + */ + resetStyles(): void; } /** @@ -6210,12 +6432,12 @@ export declare interface WarehouseAPI { * @param all - Sell in all city */ sellProduct( - divisionName: string, - cityName: string, - productName: string, - amt: string, - price: string, - all: boolean, + divisionName: string, + cityName: string, + productName: string, + amt: string, + price: string, + all: boolean, ): void; /** * Discontinue a product. @@ -6299,12 +6521,12 @@ export declare interface WarehouseAPI { * @param amt - Amount of material to export. */ exportMaterial( - sourceDivision: string, - sourceCity: string, - targetDivision: string, - targetCity: string, - materialName: string, - amt: number, + sourceDivision: string, + sourceCity: string, + targetDivision: string, + targetCity: string, + materialName: string, + amt: number, ): void; /** * Cancel material export @@ -6316,12 +6538,12 @@ export declare interface WarehouseAPI { * @param amt - Amount of material to export. */ cancelExportMaterial( - sourceDivision: string, - sourceCity: string, - targetDivision: string, - targetCity: string, - materialName: string, - amt: number, + sourceDivision: string, + sourceCity: string, + targetDivision: string, + targetCity: string, + materialName: string, + amt: number, ): void; /** * Purchase warehouse for a new city @@ -6344,11 +6566,11 @@ export declare interface WarehouseAPI { * @param marketingInvest - Amount to invest for the marketing of the product. */ makeProduct( - divisionName: string, - cityName: string, - productName: string, - designInvest: number, - marketingInvest: number, + divisionName: string, + cityName: string, + productName: string, + designInvest: number, + marketingInvest: number, ): void; } diff --git a/input/bitburner.api.json b/input/bitburner.api.json index 7b350ecfb..478af67a9 100644 --- a/input/bitburner.api.json +++ b/input/bitburner.api.json @@ -1832,6 +1832,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#GangSoftcap:member", + "docComment": "/**\n * Influences the respect gain and money gain of your gang.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "GangSoftcap: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "GangSoftcap", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!BitNodeMultipliers#HackExpGain:member", @@ -2092,6 +2118,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerSoftCap:member", + "docComment": "/**\n * Influences cost of any purchased server at or above 128GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerSoftCap: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerSoftCap", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!BitNodeMultipliers#RepToDonateToFaction:member", @@ -2121,7 +2173,7 @@ { "kind": "PropertySignature", "canonicalReference": "bitburner!BitNodeMultipliers#ScriptHackMoney:member", - "docComment": "/**\n * Influences how much money can be stolen from a server when a script performs a hack against it.\n */\n", + "docComment": "/**\n * Influences how much the money on a server can be reduced when a script performs a hack against it.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2144,6 +2196,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ScriptHackMoneyGain:member", + "docComment": "/**\n * Influences how much of the money stolen by a scripted hack will be added to the player's money.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ScriptHackMoneyGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ScriptHackMoneyGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!BitNodeMultipliers#ServerGrowthRate:member", @@ -2274,6 +2352,58 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#StaneksGiftExtraSize:member", + "docComment": "/**\n * Influences the size of the gift\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "StaneksGiftExtraSize: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "StaneksGiftExtraSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#StaneksGiftPowerMultiplier:member", + "docComment": "/**\n * Influences the power of the gift\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "StaneksGiftPowerMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "StaneksGiftPowerMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!BitNodeMultipliers#StrengthLevelMultiplier:member", @@ -2299,6 +2429,32 @@ "startIndex": 1, "endIndex": 2 } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#WorldDaemonDifficulty:member", + "docComment": "/**\n * Influences the hacking skill required to backdoor the world daemon.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "WorldDaemonDifficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "WorldDaemonDifficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } } ], "extendsTokenRanges": [] @@ -7406,6 +7562,31 @@ ], "extendsTokenRanges": [] }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!FilenameOrPID:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type FilenameOrPID = " + }, + { + "kind": "Content", + "text": "number | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FilenameOrPID", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "Interface", "canonicalReference": "bitburner!Formulas:interface", @@ -12915,6 +13096,334 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HacknetNodeConstants:interface", + "docComment": "/**\n * Hacknet node related constants\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface HacknetNodeConstants " + } + ], + "releaseTag": "Public", + "name": "HacknetNodeConstants", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#BaseCost:member", + "docComment": "/**\n * Base cost for a new node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#CoreBaseCost:member", + "docComment": "/**\n * Base cost to increase cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CoreBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CoreBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#LevelBaseCost:member", + "docComment": "/**\n * Base cost per level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "LevelBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "LevelBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#MaxCores:member", + "docComment": "/**\n * Max number of cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxCores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxCores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#MaxLevel:member", + "docComment": "/**\n * Max node level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#MaxRam:member", + "docComment": "/**\n * Max amount of RAM in GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#MoneyGainPerLevel:member", + "docComment": "/**\n * Amount of money gained per level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MoneyGainPerLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MoneyGainPerLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#PurchaseNextMult:member", + "docComment": "/**\n * Multiplier to purchase new node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchaseNextMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchaseNextMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#RamBaseCost:member", + "docComment": "/**\n * Base cost to incrase RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "RamBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "RamBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#UpgradeCoreMult:member", + "docComment": "/**\n * Multiplier to increase cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeCoreMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeCoreMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#UpgradeLevelMult:member", + "docComment": "/**\n * Multiplier to increase node level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeLevelMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeLevelMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetNodeConstants#UpgradeRamMult:member", + "docComment": "/**\n * Multiplier to increase RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeRamMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeRamMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, { "kind": "Interface", "canonicalReference": "bitburner!HacknetNodesFormulas:interface", @@ -12938,8 +13447,9 @@ "text": "constants(): " }, { - "kind": "Content", - "text": "number" + "kind": "Reference", + "text": "HacknetNodeConstants", + "canonicalReference": "bitburner!HacknetNodeConstants:interface" }, { "kind": "Content", @@ -13329,6 +13839,412 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HacknetServerConstants:interface", + "docComment": "/**\n * Hacknet server related constants\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface HacknetServerConstants " + } + ], + "releaseTag": "Public", + "name": "HacknetServerConstants", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#BaseCost:member", + "docComment": "/**\n * Base cost for a new server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#CacheBaseCost:member", + "docComment": "/**\n * Base cost to upgrade cache\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CacheBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CacheBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#CoreBaseCost:member", + "docComment": "/**\n * Base cost to increase cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CoreBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CoreBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#HashesPerLevel:member", + "docComment": "/**\n * Number of hashes calculated per level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HashesPerLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HashesPerLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#MaxCache:member", + "docComment": "/**\n * Max cache size\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxCache: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxCache", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#MaxCores:member", + "docComment": "/**\n * Max number of cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxCores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxCores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#MaxLevel:member", + "docComment": "/**\n * Max level for a server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#MaxRam:member", + "docComment": "/**\n * Max amount of RAM in GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#MaxServers:member", + "docComment": "/**\n * Max number of servers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MaxServers: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "MaxServers", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#PurchaseMult:member", + "docComment": "/**\n * Multiplier to purchase a new server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchaseMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchaseMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#RamBaseCost:member", + "docComment": "/**\n * Base cost to increase RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "RamBaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "RamBaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#UpgradeCacheMult:member", + "docComment": "/**\n * Multiplier to upgrade cache\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeCacheMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeCacheMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#UpgradeCoreMult:member", + "docComment": "/**\n * Multiplier to increase cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeCoreMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeCoreMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#UpgradeLevelMult:member", + "docComment": "/**\n * Multiplier to increase server level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeLevelMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeLevelMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetServerConstants#UpgradeRamMult:member", + "docComment": "/**\n * Multiplier to increase RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UpgradeRamMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "UpgradeRamMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, { "kind": "Interface", "canonicalReference": "bitburner!HacknetServersFormulas:interface", @@ -13411,8 +14327,9 @@ "text": "constants(): " }, { - "kind": "Content", - "text": "any" + "kind": "Reference", + "text": "HacknetServerConstants", + "canonicalReference": "bitburner!HacknetServerConstants:interface" }, { "kind": "Content", @@ -13970,6 +14887,250 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Interface", + "canonicalReference": "bitburner!NetscriptPort:interface", + "docComment": "/**\n * Object representing a port. A port is a serialized queue.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface NetscriptPort " + } + ], + "releaseTag": "Public", + "name": "NetscriptPort", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#clear:member(1)", + "docComment": "/**\n * Empties all data from the port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clear(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clear" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#empty:member(1)", + "docComment": "/**\n * Check if the port is empty.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns true if the port is empty, otherwise false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "empty(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "empty" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#full:member(1)", + "docComment": "/**\n * Check if the port is full.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns true if the port is full, otherwise false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "full(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "full" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#peek:member(1)", + "docComment": "/**\n * Retrieve the first element from the port without removing it.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned.\n *\n * @returns the data read\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "peek(): " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "peek" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#read:member(1)", + "docComment": "/**\n * Shift an element out of the port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function will remove the first element from the port and return it. If the port is empty, then the string “NULL PORT DATA” will be returned.\n *\n * @returns the data read.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "read(): " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "read" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#tryWrite:member(1)", + "docComment": "/**\n * Attempt to write data to the port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns True if the data was added to the port, false if the port was full\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tryWrite(value: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryWrite" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NetscriptPort#write:member(1)", + "docComment": "/**\n * Write data to a port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * @returns The data popped off the queue if it was full.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "write(value: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "null | string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "write" + } + ], + "extendsTokenRanges": [] + }, { "kind": "Interface", "canonicalReference": "bitburner!NodeStats:interface", @@ -14142,7 +15303,7 @@ { "kind": "PropertySignature", "canonicalReference": "bitburner!NodeStats#ram:member", - "docComment": "/**\n * Node's RAM\n */\n", + "docComment": "/**\n * Node's RAM (GB)\n */\n", "excerptTokens": [ { "kind": "Content", @@ -14168,7 +15329,7 @@ { "kind": "PropertySignature", "canonicalReference": "bitburner!NodeStats#ramUsed:member", - "docComment": "/**\n * Node's used RAM\n */\n", + "docComment": "/**\n * Node's used RAM (GB)\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15451,7 +16612,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getPortHandle:member(1)", - "docComment": "/**\n * Get all data on a port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\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 * @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 all data on a port.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\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 * @param port - Port number. Must be an integer between 1 and 20.\n *\n * @see\n *\n * https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15466,8 +16627,9 @@ "text": "): " }, { - "kind": "Content", - "text": "any[]" + "kind": "Reference", + "text": "NetscriptPort", + "canonicalReference": "bitburner!NetscriptPort:interface" }, { "kind": "Content", @@ -15495,7 +16657,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getPurchasedServerCost:member(1)", - "docComment": "/**\n * Get cost of purchasing a server.\n *\n * @remarks\n *\n * RAM cost: 0.25 GB\n *\n * Returns the cost to purchase a server with the specified amount of ram.\n *\n * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The cost to purchase a server with the specified amount of ram.\n *\n * @example\n * ```ts\n * // NS1:\n * for (i = 1; i <= 20; i++) {\n * tprint(i + \" -- \" + getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * for (i = 1; i <= 20; i++) {\n * ns.tprint(i + \" -- \" + ns.getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Get cost of purchasing a server.\n *\n * @remarks\n *\n * RAM cost: 0.25 GB\n *\n * Returns the cost to purchase a server with the specified amount of ram.\n *\n * @param ram - Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The cost to purchase a server with the specified amount of ram.\n *\n * @example\n * ```ts\n * // NS1:\n * for (i = 1; i <= 20; i++) {\n * tprint(i + \" -- \" + getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * for (i = 1; i <= 20; i++) {\n * ns.tprint(i + \" -- \" + ns.getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15567,7 +16729,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getPurchasedServerMaxRam:member(1)", - "docComment": "/**\n * Returns the maximum RAM that a purchased server can have.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @returns Returns the maximum RAM that a purchased server can have.\n */\n", + "docComment": "/**\n * Returns the maximum RAM that a purchased server can have.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @returns Returns the maximum RAM (in GB) that a purchased server can have.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15623,15 +16785,16 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getRunningScript:member(1)", - "docComment": "/**\n * Get general info about a running script.\n *\n * @remarks\n *\n * RAM cost: 0.3 GB\n *\n * Running with no args returns curent script.\n *\n * @returns info about a running script\n */\n", + "docComment": "/**\n * Get general info about a running script.\n *\n * @remarks\n *\n * RAM cost: 0.3 GB\n *\n * Running with no args returns curent script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary.\n *\n * @param filename - Optional. Filename or PID of the script.\n *\n * @param hostname - Optional. Name of host server the script is running on.\n *\n * @param args - Arguments to identify the script\n *\n * @returns info about a running script\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRunningScript(filename?: " }, { - "kind": "Content", - "text": "string | number" + "kind": "Reference", + "text": "FilenameOrPID", + "canonicalReference": "bitburner!FilenameOrPID:type" }, { "kind": "Content", @@ -16004,7 +17167,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getScriptRam:member(1)", - "docComment": "/**\n * Get the ram cost of a script.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\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 * @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", + "docComment": "/**\n * Get the ram cost of a script.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\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 * @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 (in GB) required to run the specified script on the target server, and 0 if the script does not exist.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16240,7 +17403,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerMaxRam:member(1)", - "docComment": "/**\n * Get the max RAM on a server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Hostname of the target server.\n *\n * @returns max ram\n */\n", + "docComment": "/**\n * Get the max RAM on a server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Hostname of the target server.\n *\n * @returns max ram (GB)\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16416,7 +17579,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerRam:member(1)", - "docComment": "/**\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\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 * @deprecated\n *\n * use getServerMaxRam / getServerUsedRam\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 * // NS1:\n * var serverRam = getServerRam(\"helios\");\n * var totalRam = serverRam[0];\n * var ramUsed = serverRam[1];\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * const [totalRam, ramUsed] = ns.getServerRam(\"helios\");\n * ```\n *\n */\n", + "docComment": "/**\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\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 * @deprecated\n *\n * use getServerMaxRam / getServerUsedRam\n *\n * @param host - Host of target server.\n *\n * @returns Array with total and used memory on the specified server, in GB.\n *\n * @example\n * ```ts\n * // NS1:\n * var serverRam = getServerRam(\"helios\");\n * var totalRam = serverRam[0];\n * var ramUsed = serverRam[1];\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * const [totalRam, ramUsed] = ns.getServerRam(\"helios\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -16548,7 +17711,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getServerUsedRam:member(1)", - "docComment": "/**\n * Get the used RAM on a server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Hostname of the target server.\n *\n * @returns used ram\n */\n", + "docComment": "/**\n * Get the used RAM on a server.\n *\n * @remarks\n *\n * RAM cost: 0.05 GB\n *\n * @param host - Hostname of the target server.\n *\n * @returns used ram (GB)\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17262,15 +18425,16 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#isRunning:member(1)", - "docComment": "/**\n * Check if a script is running.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\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 * @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 * // NS1:\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 * //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 * //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 * @example\n * ```ts\n * // NS2:\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 * ns.isRunning(\"foo.script\", \"foodnstuff\");\n *\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 * ns.isRunning(\"foo.script\", ns.getHostname());\n *\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 * ns.isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", + "docComment": "/**\n * Check if a script is running.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * Returns a boolean indicating whether the specified script is running on the target server. If you use a PID instead of a filename, the hostname and args parameters are unnecessary. Remember that a script is uniquely identified by both its name and its arguments.\n *\n * @param script - Filename or PID 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 * // NS1:\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 * //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 * //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 * @example\n * ```ts\n * // NS2:\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 * ns.isRunning(\"foo.script\", \"foodnstuff\");\n *\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 * ns.isRunning(\"foo.script\", ns.getHostname());\n *\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 * ns.isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isRunning(script: " }, { - "kind": "Content", - "text": "string" + "kind": "Reference", + "text": "FilenameOrPID", + "canonicalReference": "bitburner!FilenameOrPID:type" }, { "kind": "Content", @@ -17554,6 +18718,80 @@ ], "name": "ls" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#mv:member(1)", + "docComment": "/**\n * Move a file on the target server.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * NS2 exclusive\n *\n * Move the source file to the specified destination on the target server.\n *\n * This command only works for scripts and text files (.txt). It cannot, however, be used to convert from script to text file, or vice versa.\n *\n * This function can also be used to rename files.\n *\n * @param host - Host of target server.\n *\n * @param source - Filename of the source file.\n *\n * @param destination - Filename of the destination file.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mv(host: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", destination: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "mv" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#nFormat:member(1)", @@ -17846,7 +19084,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#purchaseServer:member(1)", - "docComment": "/**\n * Purchase a server.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * Purchased a server with the specified hostname and amount of RAM.\n *\n * The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls `purchaseServer(“foo”, 4)` but a server named “foo” already exists, the it will automatically change the hostname to `foo-0`. If there is already a server with the hostname `foo-0`, then it will change the hostname to `foo-1`, and so on.\n *\n * Note that there is a maximum limit to the amount of servers you can purchase.\n *\n * Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers.\n *\n * @param hostname - Host of the purchased server.\n *\n * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The hostname of the newly purchased server.\n *\n * @example\n * ```ts\n * // NS1:\n * var ram = 64;\n * var prefix = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * purchaseServer(prefix + i, ram);\n * }\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * const ram = 64;\n * const prefix = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * ns.purchaseServer(prefix + i, ram);\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Purchase a server.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * Purchased a server with the specified hostname and amount of RAM.\n *\n * The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls `purchaseServer(“foo”, 4)` but a server named “foo” already exists, the it will automatically change the hostname to `foo-0`. If there is already a server with the hostname `foo-0`, then it will change the hostname to `foo-1`, and so on.\n *\n * Note that there is a maximum limit to the amount of servers you can purchase.\n *\n * Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers.\n *\n * @param hostname - Host of the purchased server.\n *\n * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The hostname of the newly purchased server.\n *\n * @example\n * ```ts\n * // NS1:\n * var ram = 64;\n * var prefix = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * purchaseServer(prefix + i, ram);\n * }\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * const ram = 64;\n * const prefix = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * ns.purchaseServer(prefix + i, ram);\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -17905,7 +19143,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#read:member(1)", - "docComment": "/**\n * Read content of a file.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is used to read data from a port or from a text file (.txt).\n *\n * This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.\n *\n * @param handle - Port or text file to read from.\n *\n * @returns Data in the specified text file or port.\n */\n", + "docComment": "/**\n * Read content of a file.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function is used to read data from a text file (.txt).\n *\n * This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.\n *\n * @param handle - Filename to read from.\n *\n * @returns Data in the specified text file.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18220,6 +19458,70 @@ "kind": "MethodSignature", "canonicalReference": "bitburner!NS#scp:member(1)", "docComment": "/**\n * Copy file between servers.\n *\n * @remarks\n *\n * RAM cost: 0.6 GB\n *\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 * @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 * // NS1:\n * //Copies foo.lit from the helios server to the home computer:\n * scp(\"foo.lit\", \"helios\", \"home\");\n *\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 * @example\n * ```ts\n * // NS2:\n * //Copies foo.lit from the helios server to the home computer:\n * await ns.scp(\"foo.lit\", \"helios\", \"home\");\n *\n * //Tries to copy three files from rothman-uni to home computer:\n * files = [\"foo1.lit\", \"foo2.script\", \"foo3.script\"];\n * await ns.scp(files, \"rothman-uni\", \"home\");\n * ```\n *\n * @example\n * ```ts\n * //ns2, copies files from home to a target server\n * const server = ns.args[0];\n * const files = [\"hack.js\",\"weaken.js\",\"grow.js\"];\n * await ns.scp(files, \"home\", server);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scp(files: " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": ", destination: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "files", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scp:member(2)", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -18269,7 +19571,7 @@ "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 1, + "overloadIndex": 2, "parameters": [ { "parameterName": "files", @@ -18626,7 +19928,7 @@ }, { "kind": "Content", - "text": "string[]" + "text": "any[]" }, { "kind": "Content", @@ -18767,15 +20069,16 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#tail:member(1)", - "docComment": "/**\n * Open the tail window of a script.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Opens a script’s logs. This is functionally the same as the tail Terminal command.\n *\n * If the function is called with no arguments, it will open the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed.\n *\n * @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.\n *\n * @param args - Arguments for the script being tailed.\n *\n * @example\n * ```ts\n * // NS1:\n * //Open logs from foo.script on the current server that was run with no args\n * tail(\"foo.script\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * tail(\"foo.script\", \"foodnstuff\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * //Open logs from foo.script on the current server that was run with no args\n * ns.tail(\"foo.script\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * ns.tail(\"foo.script\", \"foodnstuff\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * ns.tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", + "docComment": "/**\n * Open the tail window of a script.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * Opens a script’s logs. This is functionally the same as the tail Terminal command.\n *\n * If the function is called with no arguments, it will open the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @param fn - Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed.\n *\n * @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.\n *\n * @param args - Arguments for the script being tailed.\n *\n * @example\n * ```ts\n * // NS1:\n * //Open logs from foo.script on the current server that was run with no args\n * tail(\"foo.script\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * tail(\"foo.script\", \"foodnstuff\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * //Open logs from foo.script on the current server that was run with no args\n * ns.tail(\"foo.script\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * ns.tail(\"foo.script\", \"foodnstuff\");\n *\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * ns.tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tail(fn?: " }, { - "kind": "Content", - "text": "string" + "kind": "Reference", + "text": "FilenameOrPID", + "canonicalReference": "bitburner!FilenameOrPID:type" }, { "kind": "Content", @@ -18900,7 +20203,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#toast:member(1)", - "docComment": "/**\n * Queue a toast (bottom-right notification).\n *\n * @param msg - Message in the toast.\n *\n * @param variant - Type of toast, must be one of success, info, warning, error. Defaults to success.\n *\n * @param duration - Duration of toast in ms, defaults to 2000\n */\n", + "docComment": "/**\n * Queue a toast (bottom-right notification).\n *\n * @param msg - Message in the toast.\n *\n * @param variant - Type of toast, must be one of success, info, warning, error. Defaults to success.\n *\n * @param duration - Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000\n */\n", "excerptTokens": [ { "kind": "Content", @@ -18924,7 +20227,7 @@ }, { "kind": "Content", - "text": "number" + "text": "number | null" }, { "kind": "Content", @@ -19184,7 +20487,7 @@ }, { "kind": "Content", - "text": "string[]" + "text": "any[]" }, { "kind": "Content", @@ -19430,7 +20733,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#write:member(1)", - "docComment": "/**\n * Write data to a file.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function can be used to either write data to a text file (.txt).\n *\n * This function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If *mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.\n *\n * @param handle - Port or text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @param mode - Defines the write mode. Only valid when writing to text files.\n */\n", + "docComment": "/**\n * Write data to a file.\n *\n * @remarks\n *\n * RAM cost: 0 GB\n *\n * This function can be used to write data to a text file (.txt).\n *\n * This function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If *mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.\n *\n * @param handle - Filename of the text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @param mode - Defines the write mode. Only valid when writing to text files.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -20458,6 +21761,105 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Enum", + "canonicalReference": "bitburner!OrderTypes:enum", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export enum OrderTypes " + } + ], + "releaseTag": "Public", + "name": "OrderTypes", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "bitburner!OrderTypes.LimitBuy:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LimitBuy = " + }, + { + "kind": "Content", + "text": "\"Limit Buy Order\"" + } + ], + "releaseTag": "Public", + "name": "LimitBuy", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "bitburner!OrderTypes.LimitSell:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LimitSell = " + }, + { + "kind": "Content", + "text": "\"Limit Sell Order\"" + } + ], + "releaseTag": "Public", + "name": "LimitSell", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "bitburner!OrderTypes.StopBuy:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "StopBuy = " + }, + { + "kind": "Content", + "text": "\"Stop Buy Order\"" + } + ], + "releaseTag": "Public", + "name": "StopBuy", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "bitburner!OrderTypes.StopSell:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "StopSell = " + }, + { + "kind": "Content", + "text": "\"Stop Sell Order\"" + } + ], + "releaseTag": "Public", + "name": "StopSell", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, { "kind": "Interface", "canonicalReference": "bitburner!Player:interface", @@ -22908,6 +24310,63 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Enum", + "canonicalReference": "bitburner!PositionTypes:enum", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export enum PositionTypes " + } + ], + "releaseTag": "Public", + "name": "PositionTypes", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "bitburner!PositionTypes.Long:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Long = " + }, + { + "kind": "Content", + "text": "\"L\"" + } + ], + "releaseTag": "Public", + "name": "Long", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "bitburner!PositionTypes.Short:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Short = " + }, + { + "kind": "Content", + "text": "\"S\"" + } + ], + "releaseTag": "Public", + "name": "Short", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, { "kind": "Interface", "canonicalReference": "bitburner!ProcessInfo:interface", @@ -24171,7 +25630,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!Singularity:interface", - "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", + "docComment": "/**\n * Singularity API\n *\n * @remarks\n *\n * This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24184,7 +25643,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#applyToCompany:member(1)", - "docComment": "/**\n * SF4.2 - Apply for a job at a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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", + "docComment": "/**\n * Apply for a job at a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB * 16/4/1\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", @@ -24243,7 +25702,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#checkFactionInvitations:member(1)", - "docComment": "/**\n * SF4.2 - List all current faction invitations.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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", + "docComment": "/**\n * List all current faction invitations.\n *\n * @remarks\n *\n * RAM cost: 3 GB * 16/4/1\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", @@ -24271,7 +25730,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#commitCrime:member(1)", - "docComment": "/**\n * SF4.3 - Commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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 milliseconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60,000).\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", + "docComment": "/**\n * Commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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 milliseconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60,000).\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 The number of milliseconds it takes to attempt the specified crime.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24315,7 +25774,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#connect:member(1)", - "docComment": "/**\n * SF4.1 - Connect to a server.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.\n *\n * @returns True if the connect command was successful, false otherwise.\n */\n", + "docComment": "/**\n * Connect to a server.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/1\n *\n * Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.\n *\n * @returns True if the connect command was successful, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24359,7 +25818,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#createProgram:member(1)", - "docComment": "/**\n * SF4.3 - Create a program.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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 * // NS1:\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * ns.createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", + "docComment": "/**\n * Create a program.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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 * @param focus - Acquire player focus on this program creation. Optional. Defaults to true.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```ts\n * // NS1:\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n * @example\n * ```ts\n * // NS2:\n * ns.createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24369,6 +25828,14 @@ "kind": "Content", "text": "string" }, + { + "kind": "Content", + "text": ", focus?: " + }, + { + "kind": "Content", + "text": "boolean" + }, { "kind": "Content", "text": "): " @@ -24384,8 +25851,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, @@ -24396,6 +25863,13 @@ "startIndex": 1, "endIndex": 2 } + }, + { + "parameterName": "focus", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } ], "name": "createProgram" @@ -24403,7 +25877,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#donateToFaction:member(1)", - "docComment": "/**\n * SF4.3 - Donate to a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Donate to a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -24462,7 +25936,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationCost:member(1)", - "docComment": "/**\n * SF4.3 - Get the price and reputation of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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 * @deprecated\n *\n * use getAugmentationPrice getAugmentationRepCost\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", + "docComment": "/**\n * Get the price and reputation of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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 * @deprecated\n *\n * use getAugmentationPrice getAugmentationRepCost\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with first element as a reputation requirement and second element as the money cost.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24506,7 +25980,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)", - "docComment": "/**\n * SF4.3 - Get the pre-requisite of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Get the pre-requisite of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -24550,7 +26024,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationPrice:member(1)", - "docComment": "/**\n * SF4.3 - Get price of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Price of the augmentation.\n */\n", + "docComment": "/**\n * Get price of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB * 16/4/1\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Price of the augmentation.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24594,7 +26068,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationRepReq:member(1)", - "docComment": "/**\n * SF4.3 - Get reputation requirement of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Reputation requirement of the augmentation.\n */\n", + "docComment": "/**\n * Get reputation requirement of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB * 16/4/1\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Reputation requirement of the augmentation.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24638,7 +26112,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationsFromFaction:member(1)", - "docComment": "/**\n * SF4.3 - Get a list of augmentation available from a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Get a list of augmentation available from a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -24682,7 +26156,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getAugmentationStats:member(1)", - "docComment": "/**\n * SF4.3 - Get the stats of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * This function returns augmentation stats.\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 * 16/4/1\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", @@ -24727,7 +26201,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCharacterInformation:member(1)", - "docComment": "/**\n * SF4.1 - Returns an object with various information about your character.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * @deprecated\n *\n * use getPlayer\n *\n * @returns Object with various information about your character.\n */\n", + "docComment": "/**\n * Returns an object with various information about your character.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB * 16/4/1\n *\n * @deprecated\n *\n * use getPlayer\n *\n * @returns Object with various information about your character.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -24756,7 +26230,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyFavor:member(1)", - "docComment": "/**\n * SF4.2 - Get company favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\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", + "docComment": "/**\n * Get company favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB * 16/4/1\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", @@ -24800,7 +26274,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyFavorGain:member(1)", - "docComment": "/**\n * SF4.2 - Get company favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\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", + "docComment": "/**\n * Get company favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB * 16/4/1\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", @@ -24844,7 +26318,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCompanyRep:member(1)", - "docComment": "/**\n * SF4.2 - Get company reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\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", + "docComment": "/**\n * Get company reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB * 16/4/1\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", @@ -24888,7 +26362,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCrimeChance:member(1)", - "docComment": "/**\n * SF4.3 - Get chance to successfully commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Get chance to successfully commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -24932,7 +26406,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCrimeStats:member(1)", - "docComment": "/**\n * SF4.3 - Get stats related to a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Get stats related to a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -24977,7 +26451,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getCurrentServer:member(1)", - "docComment": "/**\n * SF4.1 - Get the current server.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @returns Name of the current server.\n */\n", + "docComment": "/**\n * Get the current server.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/1\n *\n * @returns Name of the current server.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25005,7 +26479,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionFavor:member(1)", - "docComment": "/**\n * SF4.2 - Get faction favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\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", + "docComment": "/**\n * Get faction favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB * 16/4/1\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", @@ -25049,7 +26523,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionFavorGain:member(1)", - "docComment": "/**\n * SF4.2 - Get faction favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\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", + "docComment": "/**\n * Get faction favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB * 16/4/1\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", @@ -25093,7 +26567,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getFactionRep:member(1)", - "docComment": "/**\n * SF4.2 - Get faction reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\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", + "docComment": "/**\n * Get faction reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB * 16/4/1\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", @@ -25137,7 +26611,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getOwnedAugmentations:member(1)", - "docComment": "/**\n * SF4.3 - Get a list of owned augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Get a list of owned augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -25181,7 +26655,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getStats:member(1)", - "docComment": "/**\n * SF4.1 - Returns an object with the Player’s stats.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * @deprecated\n *\n * use getPlayer\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", + "docComment": "/**\n * Returns an object with the Player’s stats.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB * 16/4/1\n *\n * @deprecated\n *\n * use getPlayer\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", @@ -25210,7 +26684,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getUpgradeHomeCoresCost:member(1)", - "docComment": "/**\n * SF4.2 - Get the price of upgrading home cores.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB\n *\n * Returns the cost of upgrading the player’s home computer cores.\n *\n * @returns Cost of upgrading the player’s home computer cores.\n */\n", + "docComment": "/**\n * Get the price of upgrading home cores.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB * 16/4/1\n *\n * Returns the cost of upgrading the player’s home computer cores.\n *\n * @returns Cost of upgrading the player’s home computer cores.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25238,7 +26712,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#getUpgradeHomeRamCost:member(1)", - "docComment": "/**\n * SF4.2 - Get the price of upgrading home RAM.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB\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", + "docComment": "/**\n * Get the price of upgrading home RAM.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB * 16/4/1\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", @@ -25266,7 +26740,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#goToLocation:member(1)", - "docComment": "/**\n * SF4.3 - Go to a location.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Move the player to a specific location.\n *\n * @param locationName - Name of the location.\n *\n * @returns True if the player was moved there, false otherwise.\n */\n", + "docComment": "/**\n * Go to a location.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\n *\n * Move the player to a specific location.\n *\n * @param locationName - Name of the location.\n *\n * @returns True if the player was moved there, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25310,7 +26784,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#gymWorkout:member(1)", - "docComment": "/**\n * SF4.1 - Workout at the gym.\n *\n * @remarks\n *\n * RAM cost: 2 GB\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", + "docComment": "/**\n * Workout at the gym.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/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 * @param focus - Acquire player focus on this gym workout. Optional. Defaults to true.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25328,6 +26802,14 @@ "kind": "Content", "text": "string" }, + { + "kind": "Content", + "text": ", focus?: " + }, + { + "kind": "Content", + "text": "boolean" + }, { "kind": "Content", "text": "): " @@ -25343,8 +26825,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -25362,6 +26844,13 @@ "startIndex": 3, "endIndex": 4 } + }, + { + "parameterName": "focus", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], "name": "gymWorkout" @@ -25369,7 +26858,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#hospitalize:member(1)", - "docComment": "/**\n * SF4.1 - Hospitalize the player.\n *\n * @remarks\n *\n * RAM cost: 0.25 GB\n *\n * @returns The cost of the hospitalization.\n */\n", + "docComment": "/**\n * Hospitalize the player.\n *\n * @remarks\n *\n * RAM cost: 0.25 GB * 16/4/1\n *\n * @returns The cost of the hospitalization.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25397,7 +26886,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#installAugmentations:member(1)", - "docComment": "/**\n * SF4.3 - Install your purchased augmentations.\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Install your purchased augmentations.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -25441,7 +26930,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#installBackdoor:member(1)", - "docComment": "/**\n * SF4.1 - Run the backdoor command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @returns True if the installation was successful.\n */\n", + "docComment": "/**\n * Run the backdoor command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/1\n *\n * @returns Promise waiting for the installation to finish.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25474,7 +26963,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#isBusy:member(1)", - "docComment": "/**\n * SF4.1 - Check if the player is busy.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB\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", + "docComment": "/**\n * Check if the player is busy.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB * 16/4/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", @@ -25502,7 +26991,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#isFocused:member(1)", - "docComment": "/**\n * SF4.2 - Check if the player is focused.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @returns True if the player is focused.\n */\n", + "docComment": "/**\n * Check if the player is focused.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB * 16/4/1\n *\n * @returns True if the player is focused.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25530,7 +27019,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#joinFaction:member(1)", - "docComment": "/**\n * SF4.2 - Join a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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", + "docComment": "/**\n * Join a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB * 16/4/1\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", @@ -25574,7 +27063,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#manualHack:member(1)", - "docComment": "/**\n * SF4.1 - Run the hack command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * @returns Amount of money stolen by manual hacking.\n */\n", + "docComment": "/**\n * Run the hack command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/1\n *\n * @returns Amount of money stolen by manual hacking.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25607,7 +27096,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseAugmentation:member(1)", - "docComment": "/**\n * SF4.3 - Purchase an augmentation\n *\n * @remarks\n *\n * RAM cost: 5 GB\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", + "docComment": "/**\n * Purchase an augmentation\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\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", @@ -25666,7 +27155,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseProgram:member(1)", - "docComment": "/**\n * SF4.1 - Purchase a program from the dark web.\n *\n * @remarks\n *\n * RAM cost: 2 GB\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 * // NS1\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n * @example\n * ```ts\n * // NS2\n * ns.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 * 16/4/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 * // NS1\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n * @example\n * ```ts\n * // NS2\n * ns.purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25710,7 +27199,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#purchaseTor:member(1)", - "docComment": "/**\n * SF4.1 - Purchase the TOR router.\n *\n * @remarks\n *\n * RAM cost: 2 GB\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", + "docComment": "/**\n * Purchase the TOR router.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/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", @@ -25738,7 +27227,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#setFocus:member(1)", - "docComment": "/**\n * SF4.2 - Set the players focus.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * @returns True if the focus was changed.\n */\n", + "docComment": "/**\n * Set the players focus.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB * 16/4/1\n *\n * @returns True if the focus was changed.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25782,7 +27271,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#softReset:member(1)", - "docComment": "/**\n * SF4.3 - Soft reset the game.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\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", + "docComment": "/**\n * Soft reset the game.\n *\n * @remarks\n *\n * RAM cost: 5 GB * 16/4/1\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\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", @@ -25826,7 +27315,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#stopAction:member(1)", - "docComment": "/**\n * SF4.1 - Stop the current action.\n *\n * @remarks\n *\n * RAM cost: 1 GB\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", + "docComment": "/**\n * Stop the current action.\n *\n * @remarks\n *\n * RAM cost: 1 GB * 16/4/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", @@ -25854,7 +27343,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#travelToCity:member(1)", - "docComment": "/**\n * SF4.1 - Travel to another city.\n *\n * @remarks\n *\n * RAM cost: 2 GB\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", + "docComment": "/**\n * Travel to another city.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/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", @@ -25898,7 +27387,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#universityCourse:member(1)", - "docComment": "/**\n * SF4.1 - Take university class.\n *\n * @remarks\n *\n * RAM cost: 2 GB\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", + "docComment": "/**\n * Take university class.\n *\n * @remarks\n *\n * RAM cost: 2 GB * 16/4/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 * @param focus - Acquire player focus on this class. Optional. Defaults to true.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25916,6 +27405,14 @@ "kind": "Content", "text": "string" }, + { + "kind": "Content", + "text": ", focus?: " + }, + { + "kind": "Content", + "text": "boolean" + }, { "kind": "Content", "text": "): " @@ -25931,8 +27428,8 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, @@ -25950,6 +27447,13 @@ "startIndex": 3, "endIndex": 4 } + }, + { + "parameterName": "focus", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], "name": "universityCourse" @@ -25957,7 +27461,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#upgradeHomeCores:member(1)", - "docComment": "/**\n * SF4.2 - Upgrade home computer cores.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * This function will upgrade amount of cores on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer cores is successfully upgraded, and false otherwise.\n *\n * @returns True if the player’s home computer cores is successfully upgraded, and false otherwise.\n */\n", + "docComment": "/**\n * Upgrade home computer cores.\n *\n * @remarks\n *\n * RAM cost: 3 GB * 16/4/1\n *\n * This function will upgrade amount of cores on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer cores is successfully upgraded, and false otherwise.\n *\n * @returns True if the player’s home computer cores is successfully upgraded, and false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -25985,7 +27489,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#upgradeHomeRam:member(1)", - "docComment": "/**\n * SF4.2 - Upgrade home computer RAM.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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", + "docComment": "/**\n * Upgrade home computer RAM.\n *\n * @remarks\n *\n * RAM cost: 3 GB * 16/4/1\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", @@ -26013,7 +27517,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#workForCompany:member(1)", - "docComment": "/**\n * SF4.2 - Work for a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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 * @param focus - Acquire player focus on this work operation. Optional. Defaults to true.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * // NS1:\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 * @example\n * ```ts\n * // NS2:\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 (ns.getCompanyRep(COMPANY HERE) < VALUE) {\n * ns.workForCompany();\n * await ns.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 * 16/4/1\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 * @param focus - Acquire player focus on this work operation. Optional. Defaults to true.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * // NS1:\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 * @example\n * ```ts\n * // NS2:\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 (ns.getCompanyRep(COMPANY HERE) < VALUE) {\n * ns.workForCompany();\n * await ns.sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -26072,7 +27576,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Singularity#workForFaction:member(1)", - "docComment": "/**\n * SF4.2 - Work for a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\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 * @param focus - Acquire player focus on this work operation. Optional. Defaults to true.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * // NS1:\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 * @example\n * ```ts\n * // NS2:\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 (ns.getFactionRep(FACTION NAME) < VALUE) {\n * ns.workForFaction(FACNAME, WORKTYPE);\n * await ns.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 * 16/4/1\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 * @param focus - Acquire player focus on this work operation. Optional. Defaults to true.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * // NS1:\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 * @example\n * ```ts\n * // NS2:\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 (ns.getFactionRep(FACTION NAME) < VALUE) {\n * ns.workForFaction(FACNAME, WORKTYPE);\n * await ns.sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -28600,7 +30104,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!StockOrder:interface", - "docComment": "/**\n * Return value of {@link TIX.getOrders | getOrders}\n *\n * @public\n */\n", + "docComment": "/**\n * Return value of {@link TIX.getOrders | getOrders}\n *\n * Keys are stock symbols, properties are arrays of {@link StockOrderObject}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -28613,7 +30117,7 @@ { "kind": "IndexSignature", "canonicalReference": "bitburner!StockOrder:index(1)", - "docComment": "/**\n * Stock Symbol\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -28683,8 +30187,9 @@ "text": "position: " }, { - "kind": "Content", - "text": "string" + "kind": "Reference", + "text": "PositionTypes", + "canonicalReference": "bitburner!PositionTypes:enum" }, { "kind": "Content", @@ -28761,8 +30266,9 @@ "text": "type: " }, { - "kind": "Content", - "text": "string" + "kind": "Reference", + "text": "OrderTypes", + "canonicalReference": "bitburner!OrderTypes:enum" }, { "kind": "Content", @@ -29135,7 +30641,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 * 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", + "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. For each symbol you have a position in, the returned object will have a key with that symbol's name. The object's properties are each an array of {@link StockOrderObject} The object has the following structure:\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", @@ -29822,6 +31328,35 @@ "releaseTag": "Public", "name": "UserInterface", "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!UserInterface#getStyles:member(1)", + "docComment": "/**\n * Get the current styles\n *\n * @remarks\n *\n * RAM cost: cost: 0 GB\n *\n * @returns An object containing the player's styles\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStyles(): " + }, + { + "kind": "Reference", + "text": "IStyleSettings", + "canonicalReference": "bitburner!IStyleSettings:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getStyles" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!UserInterface#getTheme:member(1)", @@ -29851,6 +31386,34 @@ "parameters": [], "name": "getTheme" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!UserInterface#resetStyles:member(1)", + "docComment": "/**\n * Resets the player's styles to the default values\n *\n * @remarks\n *\n * RAM cost: cost: 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resetStyles(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "resetStyles" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!UserInterface#resetTheme:member(1)", @@ -29879,6 +31442,51 @@ "parameters": [], "name": "resetTheme" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!UserInterface#setStyles:member(1)", + "docComment": "/**\n * Sets the current styles\n *\n * @remarks\n *\n * RAM cost: cost: 0 GB\n *\n * @example\n *\n * Usage example (NS2)\n * ```ts\n * const styles = ns.ui.getStyles();\n * styles.fontFamily = 'Comic Sans Ms';\n * ns.ui.setStyles(styles);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setStyles(newStyles: " + }, + { + "kind": "Reference", + "text": "IStyleSettings", + "canonicalReference": "bitburner!IStyleSettings:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newStyles", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setStyles" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!UserInterface#setTheme:member(1)", diff --git a/markdown/bitburner.bitnodemultipliers.gangsoftcap.md b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md new file mode 100644 index 000000000..39e80cbcd --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) + +## BitNodeMultipliers.GangSoftcap property + +Influences the respect gain and money gain of your gang. + +Signature: + +```typescript +GangSoftcap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md index 2a7c6910e..a0ca556bf 100644 --- a/markdown/bitburner.bitnodemultipliers.md +++ b/markdown/bitburner.bitnodemultipliers.md @@ -37,6 +37,7 @@ export interface BitNodeMultipliers | [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | number | Influences how much rep the player gains when performing work for a faction. | | [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data API | | [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) | +| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | number | Influences the respect gain and money gain of your gang. | | [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | number | Influences the experienced gained when hacking a server. | | [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | number | Influences how quickly the player's hacking level (not experience) scales | | [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) | @@ -47,12 +48,17 @@ export interface BitNodeMultipliers | [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | number | Influence how much it costs to purchase a server | | [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | number | Influences the maximum number of purchased servers you can have | | [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | number | Influences the maximum allowed RAM for a purchased server | +| [PurchasedServerSoftCap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | number | Influences cost of any purchased server at or above 128GB | | [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. | -| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much money can be stolen from a server when a script performs a hack against it. | +| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much the money on a server can be reduced when a script performs a hack against it. | +| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. | | [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. | | [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maxmimum money that a server can grow to. | | [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. | | [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. | | [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. | +| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | number | Influences the size of the gift | +| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | number | Influences the power of the gift | | [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | number | Influences how quickly the player's strength level (not exp) scales | +| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | number | Influences the hacking skill required to backdoor the world daemon. | diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md new file mode 100644 index 000000000..1e1846605 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerSoftCap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) + +## BitNodeMultipliers.PurchasedServerSoftCap property + +Influences cost of any purchased server at or above 128GB + +Signature: + +```typescript +PurchasedServerSoftCap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md index 2216e1c60..c0fb0e02b 100644 --- a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md @@ -4,7 +4,7 @@ ## BitNodeMultipliers.ScriptHackMoney property -Influences how much money can be stolen from a server when a script performs a hack against it. +Influences how much the money on a server can be reduced when a script performs a hack against it. Signature: diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md new file mode 100644 index 000000000..38b82f966 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) + +## BitNodeMultipliers.ScriptHackMoneyGain property + +Influences how much of the money stolen by a scripted hack will be added to the player's money. + +Signature: + +```typescript +ScriptHackMoneyGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md new file mode 100644 index 000000000..8854881a4 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) + +## BitNodeMultipliers.StaneksGiftExtraSize property + +Influences the size of the gift + +Signature: + +```typescript +StaneksGiftExtraSize: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md new file mode 100644 index 000000000..aba511247 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) + +## BitNodeMultipliers.StaneksGiftPowerMultiplier property + +Influences the power of the gift + +Signature: + +```typescript +StaneksGiftPowerMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md new file mode 100644 index 000000000..883a1a6c2 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) + +## BitNodeMultipliers.WorldDaemonDifficulty property + +Influences the hacking skill required to backdoor the world daemon. + +Signature: + +```typescript +WorldDaemonDifficulty: number; +``` diff --git a/markdown/bitburner.filenameorpid.md b/markdown/bitburner.filenameorpid.md new file mode 100644 index 000000000..df48b9af4 --- /dev/null +++ b/markdown/bitburner.filenameorpid.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FilenameOrPID](./bitburner.filenameorpid.md) + +## FilenameOrPID type + + +Signature: + +```typescript +type FilenameOrPID = number | string; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.basecost.md b/markdown/bitburner.hacknetnodeconstants.basecost.md new file mode 100644 index 000000000..2f696b00c --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.basecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) + +## HacknetNodeConstants.BaseCost property + +Base cost for a new node + +Signature: + +```typescript +BaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.corebasecost.md b/markdown/bitburner.hacknetnodeconstants.corebasecost.md new file mode 100644 index 000000000..23431d27d --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.corebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) + +## HacknetNodeConstants.CoreBaseCost property + +Base cost to increase cores + +Signature: + +```typescript +CoreBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.levelbasecost.md b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md new file mode 100644 index 000000000..4bc92f2d7 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) + +## HacknetNodeConstants.LevelBaseCost property + +Base cost per level + +Signature: + +```typescript +LevelBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxcores.md b/markdown/bitburner.hacknetnodeconstants.maxcores.md new file mode 100644 index 000000000..4484421ac --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxcores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) + +## HacknetNodeConstants.MaxCores property + +Max number of cores + +Signature: + +```typescript +MaxCores: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxlevel.md b/markdown/bitburner.hacknetnodeconstants.maxlevel.md new file mode 100644 index 000000000..87cf76ee8 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) + +## HacknetNodeConstants.MaxLevel property + +Max node level + +Signature: + +```typescript +MaxLevel: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxram.md b/markdown/bitburner.hacknetnodeconstants.maxram.md new file mode 100644 index 000000000..f3c6ee99e --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) + +## HacknetNodeConstants.MaxRam property + +Max amount of RAM in GB + +Signature: + +```typescript +MaxRam: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.md b/markdown/bitburner.hacknetnodeconstants.md new file mode 100644 index 000000000..427c5b089 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) + +## HacknetNodeConstants interface + +Hacknet node related constants + +Signature: + +```typescript +export interface HacknetNodeConstants +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) | number | Base cost for a new node | +| [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) | number | Base cost to increase cores | +| [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) | number | Base cost per level | +| [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) | number | Max number of cores | +| [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) | number | Max node level | +| [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | number | Max amount of RAM in GB | +| [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | number | Amount of money gained per level | +| [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | number | Multiplier to purchase new node | +| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | number | Base cost to incrase RAM | +| [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | number | Multiplier to increase cores | +| [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | number | Multiplier to increase node level | +| [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | number | Multiplier to increase RAM | + diff --git a/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md new file mode 100644 index 000000000..456437ca2 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) + +## HacknetNodeConstants.MoneyGainPerLevel property + +Amount of money gained per level + +Signature: + +```typescript +MoneyGainPerLevel: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md new file mode 100644 index 000000000..fc9981f6a --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) + +## HacknetNodeConstants.PurchaseNextMult property + +Multiplier to purchase new node + +Signature: + +```typescript +PurchaseNextMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.rambasecost.md b/markdown/bitburner.hacknetnodeconstants.rambasecost.md new file mode 100644 index 000000000..04a5494f1 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.rambasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) + +## HacknetNodeConstants.RamBaseCost property + +Base cost to incrase RAM + +Signature: + +```typescript +RamBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md new file mode 100644 index 000000000..4ddd2bbc2 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) + +## HacknetNodeConstants.UpgradeCoreMult property + +Multiplier to increase cores + +Signature: + +```typescript +UpgradeCoreMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md new file mode 100644 index 000000000..daa8553c4 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) + +## HacknetNodeConstants.UpgradeLevelMult property + +Multiplier to increase node level + +Signature: + +```typescript +UpgradeLevelMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgraderammult.md b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md new file mode 100644 index 000000000..899902b70 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) + +## HacknetNodeConstants.UpgradeRamMult property + +Multiplier to increase RAM + +Signature: + +```typescript +UpgradeRamMult: number; +``` diff --git a/markdown/bitburner.hacknetnodesformulas.constants.md b/markdown/bitburner.hacknetnodesformulas.constants.md index 15c84f42d..455463122 100644 --- a/markdown/bitburner.hacknetnodesformulas.constants.md +++ b/markdown/bitburner.hacknetnodesformulas.constants.md @@ -9,11 +9,11 @@ All constants used by the game. Signature: ```typescript -constants(): number; +constants(): HacknetNodeConstants; ``` Returns: -number +[HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) An object with all hacknet node constants used by the game. diff --git a/markdown/bitburner.hacknetserverconstants.basecost.md b/markdown/bitburner.hacknetserverconstants.basecost.md new file mode 100644 index 000000000..ea787cddc --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.basecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [BaseCost](./bitburner.hacknetserverconstants.basecost.md) + +## HacknetServerConstants.BaseCost property + +Base cost for a new server + +Signature: + +```typescript +BaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.cachebasecost.md b/markdown/bitburner.hacknetserverconstants.cachebasecost.md new file mode 100644 index 000000000..d532f156d --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.cachebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) + +## HacknetServerConstants.CacheBaseCost property + +Base cost to upgrade cache + +Signature: + +```typescript +CacheBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.corebasecost.md b/markdown/bitburner.hacknetserverconstants.corebasecost.md new file mode 100644 index 000000000..856c37f59 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.corebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) + +## HacknetServerConstants.CoreBaseCost property + +Base cost to increase cores + +Signature: + +```typescript +CoreBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.hashesperlevel.md b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md new file mode 100644 index 000000000..4c0a296e2 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) + +## HacknetServerConstants.HashesPerLevel property + +Number of hashes calculated per level + +Signature: + +```typescript +HashesPerLevel: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxcache.md b/markdown/bitburner.hacknetserverconstants.maxcache.md new file mode 100644 index 000000000..b5beb72a2 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxcache.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) + +## HacknetServerConstants.MaxCache property + +Max cache size + +Signature: + +```typescript +MaxCache: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxcores.md b/markdown/bitburner.hacknetserverconstants.maxcores.md new file mode 100644 index 000000000..eecad52ca --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxcores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) + +## HacknetServerConstants.MaxCores property + +Max number of cores + +Signature: + +```typescript +MaxCores: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxlevel.md b/markdown/bitburner.hacknetserverconstants.maxlevel.md new file mode 100644 index 000000000..20a1d3167 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) + +## HacknetServerConstants.MaxLevel property + +Max level for a server + +Signature: + +```typescript +MaxLevel: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxram.md b/markdown/bitburner.hacknetserverconstants.maxram.md new file mode 100644 index 000000000..d67e2bb32 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxRam](./bitburner.hacknetserverconstants.maxram.md) + +## HacknetServerConstants.MaxRam property + +Max amount of RAM in GB + +Signature: + +```typescript +MaxRam: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxservers.md b/markdown/bitburner.hacknetserverconstants.maxservers.md new file mode 100644 index 000000000..d4808ddf9 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxservers.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) + +## HacknetServerConstants.MaxServers property + +Max number of servers + +Signature: + +```typescript +MaxServers: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.md b/markdown/bitburner.hacknetserverconstants.md new file mode 100644 index 000000000..e12db4ba9 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) + +## HacknetServerConstants interface + +Hacknet server related constants + +Signature: + +```typescript +export interface HacknetServerConstants +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [BaseCost](./bitburner.hacknetserverconstants.basecost.md) | number | Base cost for a new server | +| [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) | number | Base cost to upgrade cache | +| [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) | number | Base cost to increase cores | +| [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) | number | Number of hashes calculated per level | +| [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) | number | Max cache size | +| [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) | number | Max number of cores | +| [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) | number | Max level for a server | +| [MaxRam](./bitburner.hacknetserverconstants.maxram.md) | number | Max amount of RAM in GB | +| [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) | number | Max number of servers | +| [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) | number | Multiplier to purchase a new server | +| [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) | number | Base cost to increase RAM | +| [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) | number | Multiplier to upgrade cache | +| [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) | number | Multiplier to increase cores | +| [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) | number | Multiplier to increase server level | +| [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) | number | Multiplier to increase RAM | + diff --git a/markdown/bitburner.hacknetserverconstants.purchasemult.md b/markdown/bitburner.hacknetserverconstants.purchasemult.md new file mode 100644 index 000000000..32eef9e8a --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.purchasemult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) + +## HacknetServerConstants.PurchaseMult property + +Multiplier to purchase a new server + +Signature: + +```typescript +PurchaseMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.rambasecost.md b/markdown/bitburner.hacknetserverconstants.rambasecost.md new file mode 100644 index 000000000..365a154ae --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.rambasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) + +## HacknetServerConstants.RamBaseCost property + +Base cost to increase RAM + +Signature: + +```typescript +RamBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradecachemult.md b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md new file mode 100644 index 000000000..7fdfe9eb0 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) + +## HacknetServerConstants.UpgradeCacheMult property + +Multiplier to upgrade cache + +Signature: + +```typescript +UpgradeCacheMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradecoremult.md b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md new file mode 100644 index 000000000..2c6541d46 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) + +## HacknetServerConstants.UpgradeCoreMult property + +Multiplier to increase cores + +Signature: + +```typescript +UpgradeCoreMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md new file mode 100644 index 000000000..81a67ecff --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) + +## HacknetServerConstants.UpgradeLevelMult property + +Multiplier to increase server level + +Signature: + +```typescript +UpgradeLevelMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgraderammult.md b/markdown/bitburner.hacknetserverconstants.upgraderammult.md new file mode 100644 index 000000000..5273537c3 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgraderammult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) + +## HacknetServerConstants.UpgradeRamMult property + +Multiplier to increase RAM + +Signature: + +```typescript +UpgradeRamMult: number; +``` diff --git a/markdown/bitburner.hacknetserversformulas.constants.md b/markdown/bitburner.hacknetserversformulas.constants.md index e0a224904..e17c88b5a 100644 --- a/markdown/bitburner.hacknetserversformulas.constants.md +++ b/markdown/bitburner.hacknetserversformulas.constants.md @@ -9,11 +9,11 @@ All constants used by the game. Signature: ```typescript -constants(): any; +constants(): HacknetServerConstants; ``` Returns: -any +[HacknetServerConstants](./bitburner.hacknetserverconstants.md) An object with all hacknet server constants used by the game. diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 962f2ee1a..4837f78bc 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -4,6 +4,13 @@ ## bitburner package +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [OrderTypes](./bitburner.ordertypes.md) | | +| [PositionTypes](./bitburner.positiontypes.md) | | + ## Interfaces | Interface | Description | @@ -41,9 +48,12 @@ | [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | | [Hacknet](./bitburner.hacknet.md) | Hacknet API | | [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. | +| [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants | | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas | +| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas | | [Material](./bitburner.material.md) | Material in a warehouse | +| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. | | [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. | | [NS](./bitburner.ns.md) | Collection of all functions passed to scripts | | [Office](./bitburner.office.md) | Office for a division in a city. | @@ -63,10 +73,16 @@ | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | | | [SourceFileLvl](./bitburner.sourcefilelvl.md) | | | [Stanek](./bitburner.stanek.md) | Stanek's Gift API. | -| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) | +| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) | | [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | | [TIX](./bitburner.tix.md) | Stock market API | | [UserInterface](./bitburner.userinterface.md) | User Interface API. | | [Warehouse](./bitburner.warehouse.md) | Warehouse for a division in a city | | [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API | +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [FilenameOrPID](./bitburner.filenameorpid.md) | | + diff --git a/markdown/bitburner.netscriptport.clear.md b/markdown/bitburner.netscriptport.clear.md new file mode 100644 index 000000000..a3c2d5267 --- /dev/null +++ b/markdown/bitburner.netscriptport.clear.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [clear](./bitburner.netscriptport.clear.md) + +## NetscriptPort.clear() method + +Empties all data from the port. + +Signature: + +```typescript +clear(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.empty.md b/markdown/bitburner.netscriptport.empty.md new file mode 100644 index 000000000..50e3b972d --- /dev/null +++ b/markdown/bitburner.netscriptport.empty.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [empty](./bitburner.netscriptport.empty.md) + +## NetscriptPort.empty() method + +Check if the port is empty. + +Signature: + +```typescript +empty(): boolean; +``` +Returns: + +boolean + +true if the port is empty, otherwise false + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.full.md b/markdown/bitburner.netscriptport.full.md new file mode 100644 index 000000000..b21d20999 --- /dev/null +++ b/markdown/bitburner.netscriptport.full.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [full](./bitburner.netscriptport.full.md) + +## NetscriptPort.full() method + +Check if the port is full. + +Signature: + +```typescript +full(): boolean; +``` +Returns: + +boolean + +true if the port is full, otherwise false + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.md b/markdown/bitburner.netscriptport.md new file mode 100644 index 000000000..e18dc5bf0 --- /dev/null +++ b/markdown/bitburner.netscriptport.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) + +## NetscriptPort interface + +Object representing a port. A port is a serialized queue. + +Signature: + +```typescript +export interface NetscriptPort +``` + +## Methods + +| Method | Description | +| --- | --- | +| [clear()](./bitburner.netscriptport.clear.md) | Empties all data from the port. | +| [empty()](./bitburner.netscriptport.empty.md) | Check if the port is empty. | +| [full()](./bitburner.netscriptport.full.md) | Check if the port is full. | +| [peek()](./bitburner.netscriptport.peek.md) | Retrieve the first element from the port without removing it. | +| [read()](./bitburner.netscriptport.read.md) | Shift an element out of the port. | +| [tryWrite(value)](./bitburner.netscriptport.trywrite.md) | Attempt to write data to the port. | +| [write(value)](./bitburner.netscriptport.write.md) | Write data to a port. | + diff --git a/markdown/bitburner.netscriptport.peek.md b/markdown/bitburner.netscriptport.peek.md new file mode 100644 index 000000000..0eff71996 --- /dev/null +++ b/markdown/bitburner.netscriptport.peek.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [peek](./bitburner.netscriptport.peek.md) + +## NetscriptPort.peek() method + +Retrieve the first element from the port without removing it. + +Signature: + +```typescript +peek(): string | number; +``` +Returns: + +string \| number + +the data read + +## Remarks + +RAM cost: 0 GB + +This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.netscriptport.read.md b/markdown/bitburner.netscriptport.read.md new file mode 100644 index 000000000..ecb741f7d --- /dev/null +++ b/markdown/bitburner.netscriptport.read.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [read](./bitburner.netscriptport.read.md) + +## NetscriptPort.read() method + +Shift an element out of the port. + +Signature: + +```typescript +read(): string | number; +``` +Returns: + +string \| number + +the data read. + +## Remarks + +RAM cost: 0 GB + +This function will remove the first element from the port and return it. If the port is empty, then the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.netscriptport.trywrite.md b/markdown/bitburner.netscriptport.trywrite.md new file mode 100644 index 000000000..0a7df6d19 --- /dev/null +++ b/markdown/bitburner.netscriptport.trywrite.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [tryWrite](./bitburner.netscriptport.trywrite.md) + +## NetscriptPort.tryWrite() method + +Attempt to write data to the port. + +Signature: + +```typescript +tryWrite(value: string | number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string \| number | | + +Returns: + +boolean + +True if the data was added to the port, false if the port was full + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.write.md b/markdown/bitburner.netscriptport.write.md new file mode 100644 index 000000000..bce036633 --- /dev/null +++ b/markdown/bitburner.netscriptport.write.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [write](./bitburner.netscriptport.write.md) + +## NetscriptPort.write() method + +Write data to a port. + +Signature: + +```typescript +write(value: string | number): null | string | number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string \| number | | + +Returns: + +null \| string \| number + +The data popped off the queue if it was full. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md index bf29aedb0..cb40cbf96 100644 --- a/markdown/bitburner.nodestats.md +++ b/markdown/bitburner.nodestats.md @@ -22,8 +22,8 @@ export interface NodeStats | [level](./bitburner.nodestats.level.md) | number | Node's level | | [name](./bitburner.nodestats.name.md) | string | Node's name | | [production](./bitburner.nodestats.production.md) | number | Node's production per second | -| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM | -| [ramUsed](./bitburner.nodestats.ramused.md) | number | Node's used RAM | +| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM (GB) | +| [ramUsed](./bitburner.nodestats.ramused.md) | number | Node's used RAM (GB) | | [timeOnline](./bitburner.nodestats.timeonline.md) | number | Number of seconds since Node has been purchased | | [totalProduction](./bitburner.nodestats.totalproduction.md) | number | Total number of money Node has produced | diff --git a/markdown/bitburner.nodestats.ram.md b/markdown/bitburner.nodestats.ram.md index 48acd6ccc..4160f7b9c 100644 --- a/markdown/bitburner.nodestats.ram.md +++ b/markdown/bitburner.nodestats.ram.md @@ -4,7 +4,7 @@ ## NodeStats.ram property -Node's RAM +Node's RAM (GB) Signature: diff --git a/markdown/bitburner.nodestats.ramused.md b/markdown/bitburner.nodestats.ramused.md index 2d85e9639..965fab9a9 100644 --- a/markdown/bitburner.nodestats.ramused.md +++ b/markdown/bitburner.nodestats.ramused.md @@ -4,7 +4,7 @@ ## NodeStats.ramUsed property -Node's used RAM +Node's used RAM (GB) Signature: diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md index 5c6f610fe..b448275ca 100644 --- a/markdown/bitburner.ns.getporthandle.md +++ b/markdown/bitburner.ns.getporthandle.md @@ -9,7 +9,7 @@ Get all data on a port. Signature: ```typescript -getPortHandle(port: number): any[]; +getPortHandle(port: number): NetscriptPort; ``` ## Parameters @@ -20,9 +20,7 @@ getPortHandle(port: number): any[]; Returns: -any\[\] - -Data in the specified port. +[NetscriptPort](./bitburner.netscriptport.md) ## Remarks diff --git a/markdown/bitburner.ns.getpurchasedservercost.md b/markdown/bitburner.ns.getpurchasedservercost.md index 3064ac046..ece08176d 100644 --- a/markdown/bitburner.ns.getpurchasedservercost.md +++ b/markdown/bitburner.ns.getpurchasedservercost.md @@ -16,7 +16,7 @@ getPurchasedServerCost(ram: number): number; | Parameter | Type | Description | | --- | --- | --- | -| ram | number | Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | +| ram | number | Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | Returns: diff --git a/markdown/bitburner.ns.getpurchasedservermaxram.md b/markdown/bitburner.ns.getpurchasedservermaxram.md index 490972a3a..d48a0ef88 100644 --- a/markdown/bitburner.ns.getpurchasedservermaxram.md +++ b/markdown/bitburner.ns.getpurchasedservermaxram.md @@ -15,7 +15,7 @@ getPurchasedServerMaxRam(): number; number -Returns the maximum RAM that a purchased server can have. +Returns the maximum RAM (in GB) that a purchased server can have. ## Remarks diff --git a/markdown/bitburner.ns.getrunningscript.md b/markdown/bitburner.ns.getrunningscript.md index 2c3b60733..361c2bae2 100644 --- a/markdown/bitburner.ns.getrunningscript.md +++ b/markdown/bitburner.ns.getrunningscript.md @@ -9,16 +9,16 @@ Get general info about a running script. Signature: ```typescript -getRunningScript(filename?: string | number, hostname?: string, ...args: (string | number)[]): RunningScript; +getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| filename | string \| number | | -| hostname | string | | -| args | (string \| number)\[\] | | +| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. | +| hostname | string | Optional. Name of host server the script is running on. | +| args | (string \| number)\[\] | Arguments to identify the script | Returns: @@ -30,5 +30,5 @@ info about a running script RAM cost: 0.3 GB -Running with no args returns curent script. +Running with no args returns curent script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary. diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md index 328fd2349..2320f05ab 100644 --- a/markdown/bitburner.ns.getscriptram.md +++ b/markdown/bitburner.ns.getscriptram.md @@ -23,7 +23,7 @@ getScriptRam(script: string, host?: string): number; number -Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. +Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist. ## Remarks diff --git a/markdown/bitburner.ns.getservermaxram.md b/markdown/bitburner.ns.getservermaxram.md index fa9c97f3f..6a0cca314 100644 --- a/markdown/bitburner.ns.getservermaxram.md +++ b/markdown/bitburner.ns.getservermaxram.md @@ -22,7 +22,7 @@ getServerMaxRam(host: string): number; number -max ram +max ram (GB) ## Remarks diff --git a/markdown/bitburner.ns.getserverram.md b/markdown/bitburner.ns.getserverram.md index 50614430c..8e0844bd8 100644 --- a/markdown/bitburner.ns.getserverram.md +++ b/markdown/bitburner.ns.getserverram.md @@ -25,7 +25,7 @@ getServerRam(host: string): [number, number]; \[number, number\] -Array with total and used memory on the specified server. +Array with total and used memory on the specified server, in GB. ## Remarks diff --git a/markdown/bitburner.ns.getserverusedram.md b/markdown/bitburner.ns.getserverusedram.md index ece3afd9c..a208b3a99 100644 --- a/markdown/bitburner.ns.getserverusedram.md +++ b/markdown/bitburner.ns.getserverusedram.md @@ -22,7 +22,7 @@ getServerUsedRam(host: string): number; number -used ram +used ram (GB) ## Remarks diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md index 44c102493..93936e227 100644 --- a/markdown/bitburner.ns.isrunning.md +++ b/markdown/bitburner.ns.isrunning.md @@ -9,14 +9,14 @@ Check if a script is running. Signature: ```typescript -isRunning(script: string, host: string, ...args: string[]): boolean; +isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| script | string | Filename of script to check. This is case-sensitive. | +| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | | host | string | Host of target server. | | args | string\[\] | Arguments to specify/identify which scripts to search for. | @@ -30,7 +30,7 @@ True if specified script is running on the target server, and false otherwise. RAM cost: 0.1 GB -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. +Returns a boolean indicating whether the specified script is running on the target server. If you use a PID instead of a filename, the hostname and args parameters are unnecessary. Remember that a script is uniquely identified by both its name and its arguments. ## Example 1 diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index c74565586..dccbce410 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -125,6 +125,7 @@ export async function main(ns) { | [kill(script, host, args)](./bitburner.ns.kill_1.md) | | | [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | | [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. | +| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | | [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number | | [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | | [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. | @@ -138,7 +139,8 @@ export async function main(ns) { | [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | | [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. | | [scan(host)](./bitburner.ns.scan.md) | Get the list of servers connected to a server. | -| [scp(files, source, destination)](./bitburner.ns.scp.md) | Copy file between servers. | +| [scp(files, destination)](./bitburner.ns.scp.md) | Copy file between servers. | +| [scp(files, source, destination)](./bitburner.ns.scp_1.md) | | | [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. | | [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. | | [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | diff --git a/markdown/bitburner.ns.mv.md b/markdown/bitburner.ns.mv.md index 9439eca16..8b3628f1a 100644 --- a/markdown/bitburner.ns.mv.md +++ b/markdown/bitburner.ns.mv.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [atExit](./bitburner.ns.atexit.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [mv](./bitburner.ns.mv.md) ## NS.mv() method @@ -32,7 +32,7 @@ NS2 exclusive Move the source file to the specified destination on the target server. -This command only works for scripts and text files (.txt). It cannot, however, be used -to convert from script to text file, or vice versa. +This command only works for scripts and text files (.txt). It cannot, however, be used to convert from script to text file, or vice versa. This function can also be used to rename files. + diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md index ce328e464..9260c9b70 100644 --- a/markdown/bitburner.ns.purchaseserver.md +++ b/markdown/bitburner.ns.purchaseserver.md @@ -17,7 +17,7 @@ purchaseServer(hostname: string, ram: number): string; | Parameter | Type | Description | | --- | --- | --- | | hostname | string | Host of the purchased server. | -| ram | number | Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | +| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | Returns: diff --git a/markdown/bitburner.ns.read.md b/markdown/bitburner.ns.read.md index 869ddd7c1..b27a20712 100644 --- a/markdown/bitburner.ns.read.md +++ b/markdown/bitburner.ns.read.md @@ -16,19 +16,19 @@ read(handle: string): any; | Parameter | Type | Description | | --- | --- | --- | -| handle | string | Port or text file to read from. | +| handle | string | Filename to read from. | Returns: any -Data in the specified text file or port. +Data in the specified text file. ## Remarks RAM cost: 0 GB -This function is used to read data from a port or from a text file (.txt). +This function is used to read data from a text file (.txt). This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned. diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md index efe30cca0..3141c89e5 100644 --- a/markdown/bitburner.ns.scp.md +++ b/markdown/bitburner.ns.scp.md @@ -9,7 +9,7 @@ Copy file between servers. Signature: ```typescript -scp(files: string | string[], source: string, destination: string): Promise; +scp(files: string | string[], destination: string): Promise; ``` ## Parameters @@ -17,7 +17,6 @@ scp(files: string | string[], source: string, destination: string): PromiseReturns: diff --git a/markdown/bitburner.ns.scp_1.md b/markdown/bitburner.ns.scp_1.md new file mode 100644 index 000000000..516ed8863 --- /dev/null +++ b/markdown/bitburner.ns.scp_1.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp_1.md) + +## NS.scp() method + +Signature: + +```typescript +scp(files: string | string[], source: string, destination: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| files | string \| string\[\] | | +| source | string | | +| destination | string | | + +Returns: + +Promise<boolean> + diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md index 4b3880d6f..5520dc18a 100644 --- a/markdown/bitburner.ns.sprintf.md +++ b/markdown/bitburner.ns.sprintf.md @@ -14,10 +14,10 @@ sprintf(format: string, ...args: any[]): string; ## Parameters -| Parameter | Type | Description | -| --------- | ------- | -------------------- | -| format | string | String to format. | -| args | any\[\] | Formating arguments. | +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | any\[\] | Formating arguments. | Returns: @@ -30,3 +30,4 @@ Formated text. RAM cost: 0 GB see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.tail.md b/markdown/bitburner.ns.tail.md index ba1d98ca7..504d09ebb 100644 --- a/markdown/bitburner.ns.tail.md +++ b/markdown/bitburner.ns.tail.md @@ -9,14 +9,14 @@ Open the tail window of a script. Signature: ```typescript -tail(fn?: string, host?: string, ...args: any[]): void; +tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| fn | string | Optional. Filename of the script being tailed. If omitted, the current script is tailed. | +| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | | host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | | args | any\[\] | Arguments for the script being tailed. | diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md index 9e70bdeca..e839c6d54 100644 --- a/markdown/bitburner.ns.toast.md +++ b/markdown/bitburner.ns.toast.md @@ -9,7 +9,7 @@ Queue a toast (bottom-right notification). Signature: ```typescript -toast(msg: any, variant?: string, duration?: number): void; +toast(msg: any, variant?: string, duration?: number | null): void; ``` ## Parameters @@ -18,7 +18,7 @@ toast(msg: any, variant?: string, duration?: number): void; | --- | --- | --- | | msg | any | Message in the toast. | | variant | string | Type of toast, must be one of success, info, warning, error. Defaults to success. | -| duration | number | Duration of toast in ms, defaults to 2000 | +| duration | number \| null | Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000 | Returns: diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md index 0ace718b0..06d4d19e0 100644 --- a/markdown/bitburner.ns.vsprintf.md +++ b/markdown/bitburner.ns.vsprintf.md @@ -14,10 +14,10 @@ vsprintf(format: string, args: any[]): string; ## Parameters -| Parameter | Type | Description | -| --------- | ------- | -------------------- | -| format | string | String to format. | -| args | any\[\] | Formating arguments. | +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | any\[\] | Formating arguments. | Returns: @@ -30,3 +30,4 @@ Formated text. RAM cost: 0 GB see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md index 726ff27ed..170b1eb99 100644 --- a/markdown/bitburner.ns.write.md +++ b/markdown/bitburner.ns.write.md @@ -16,7 +16,7 @@ write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Prom | Parameter | Type | Description | | --- | --- | --- | -| handle | string | Port or text file that will be written to. | +| handle | string | Filename of the text file that will be written to. | | data | string\[\] \| number \| string | Data to write. | | mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. | @@ -28,7 +28,7 @@ Promise<void> RAM cost: 0 GB -This function can be used to either write data to a text file (.txt). +This function can be used to write data to a text file (.txt). 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.ordertypes.md b/markdown/bitburner.ordertypes.md new file mode 100644 index 000000000..4753ee345 --- /dev/null +++ b/markdown/bitburner.ordertypes.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderTypes](./bitburner.ordertypes.md) + +## OrderTypes enum + + +Signature: + +```typescript +export enum OrderTypes +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| LimitBuy | "Limit Buy Order" | | +| LimitSell | "Limit Sell Order" | | +| StopBuy | "Stop Buy Order" | | +| StopSell | "Stop Sell Order" | | + diff --git a/markdown/bitburner.positiontypes.md b/markdown/bitburner.positiontypes.md new file mode 100644 index 000000000..8946c1037 --- /dev/null +++ b/markdown/bitburner.positiontypes.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PositionTypes](./bitburner.positiontypes.md) + +## PositionTypes enum + + +Signature: + +```typescript +export enum PositionTypes +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Long | "L" | | +| Short | "S" | | + diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md index 3ae32a4c7..eeeb6b45a 100644 --- a/markdown/bitburner.singularity.applytocompany.md +++ b/markdown/bitburner.singularity.applytocompany.md @@ -4,7 +4,7 @@ ## Singularity.applyToCompany() method -SF4.2 - Apply for a job at a company. +Apply for a job at a company. Signature: @@ -27,7 +27,7 @@ True if the player successfully get a job/promotion, and false otherwise. ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at. diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md index 4d10ee652..ee1f7f534 100644 --- a/markdown/bitburner.singularity.checkfactioninvitations.md +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -4,7 +4,7 @@ ## Singularity.checkFactionInvitations() method -SF4.2 - List all current faction invitations. +List all current faction invitations. Signature: @@ -19,7 +19,7 @@ Array with the name of all Factions you currently have oustanding invitations fr ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 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 7d62e41f0..9f7f8f6bf 100644 --- a/markdown/bitburner.singularity.commitcrime.md +++ b/markdown/bitburner.singularity.commitcrime.md @@ -4,7 +4,7 @@ ## Singularity.commitCrime() method -SF4.3 - Commit a crime. +Commit a crime. Signature: @@ -22,11 +22,11 @@ commitCrime(crime: string): number; number -True if you successfully start working on the specified program, and false otherwise. +The number of milliseconds it takes to attempt the specified crime. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. diff --git a/markdown/bitburner.singularity.connect.md b/markdown/bitburner.singularity.connect.md index cfce8e89b..97fe2ffa0 100644 --- a/markdown/bitburner.singularity.connect.md +++ b/markdown/bitburner.singularity.connect.md @@ -4,7 +4,7 @@ ## Singularity.connect() method -SF4.1 - Connect to a server. +Connect to a server. Signature: @@ -26,7 +26,7 @@ True if the connect command was successful, false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 Run the connect HOSTNAME command in the terminal. Can only connect to neighbors. diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md index 70ff04ff6..f856dcc9e 100644 --- a/markdown/bitburner.singularity.createprogram.md +++ b/markdown/bitburner.singularity.createprogram.md @@ -4,12 +4,12 @@ ## Singularity.createProgram() method -SF4.3 - Create a program. +Create a program. Signature: ```typescript -createProgram(program: string): boolean; +createProgram(program: string, focus?: boolean): boolean; ``` ## Parameters @@ -17,6 +17,7 @@ createProgram(program: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | program | string | Name of program to create. | +| focus | boolean | Acquire player focus on this program creation. Optional. Defaults to true. | Returns: @@ -26,7 +27,7 @@ True if you successfully start working on the specified program, and false other ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings. diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md index 69120623b..1fa0e81b6 100644 --- a/markdown/bitburner.singularity.donatetofaction.md +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -4,7 +4,7 @@ ## Singularity.donateToFaction() method -SF4.3 - Donate to a faction. +Donate to a faction. Signature: @@ -27,7 +27,7 @@ True if the money was donated, and false otherwise. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. diff --git a/markdown/bitburner.singularity.getaugmentationcost.md b/markdown/bitburner.singularity.getaugmentationcost.md index 1223be4b2..af7f3b7fa 100644 --- a/markdown/bitburner.singularity.getaugmentationcost.md +++ b/markdown/bitburner.singularity.getaugmentationcost.md @@ -9,7 +9,7 @@ > use getAugmentationPrice getAugmentationRepCost > -SF4.3 - Get the price and reputation of an augmentation. +Get the price and reputation of an augmentation. Signature: @@ -31,7 +31,7 @@ Array with first element as a reputation requirement and second element as the m ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 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. diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md index decb7964e..5eea5c996 100644 --- a/markdown/bitburner.singularity.getaugmentationprereq.md +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -4,7 +4,7 @@ ## Singularity.getAugmentationPrereq() method -SF4.3 - Get the pre-requisite of an augmentation. +Get the pre-requisite of an augmentation. Signature: @@ -26,7 +26,7 @@ Array with the names of the prerequisite Augmentation(s) for the specified Augme ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. diff --git a/markdown/bitburner.singularity.getaugmentationprice.md b/markdown/bitburner.singularity.getaugmentationprice.md index fa6d10f44..d071bd667 100644 --- a/markdown/bitburner.singularity.getaugmentationprice.md +++ b/markdown/bitburner.singularity.getaugmentationprice.md @@ -4,7 +4,7 @@ ## Singularity.getAugmentationPrice() method -SF4.3 - Get price of an augmentation. +Get price of an augmentation. Signature: @@ -26,5 +26,5 @@ Price of the augmentation. ## Remarks -RAM cost: 2.5 GB +RAM cost: 2.5 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.getaugmentationrepreq.md b/markdown/bitburner.singularity.getaugmentationrepreq.md index bd51277e1..4813a92dc 100644 --- a/markdown/bitburner.singularity.getaugmentationrepreq.md +++ b/markdown/bitburner.singularity.getaugmentationrepreq.md @@ -4,7 +4,7 @@ ## Singularity.getAugmentationRepReq() method -SF4.3 - Get reputation requirement of an augmentation. +Get reputation requirement of an augmentation. Signature: @@ -26,5 +26,5 @@ Reputation requirement of the augmentation. ## Remarks -RAM cost: 2.5 GB +RAM cost: 2.5 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md index ba36de1da..d12b08943 100644 --- a/markdown/bitburner.singularity.getaugmentationsfromfaction.md +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -4,7 +4,7 @@ ## Singularity.getAugmentationsFromFaction() method -SF4.3 - Get a list of augmentation available from a faction. +Get a list of augmentation available from a faction. Signature: @@ -26,7 +26,7 @@ Array containing the names of all Augmentations. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md index df0a8cf06..f4d716200 100644 --- a/markdown/bitburner.singularity.getaugmentationstats.md +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -4,7 +4,7 @@ ## Singularity.getAugmentationStats() method -SF4.3 - Get the stats of an augmentation. +Get the stats of an augmentation. Signature: @@ -26,7 +26,7 @@ Augmentation stats. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function returns augmentation stats. diff --git a/markdown/bitburner.singularity.getcharacterinformation.md b/markdown/bitburner.singularity.getcharacterinformation.md index c1da05a3f..4444cd2d0 100644 --- a/markdown/bitburner.singularity.getcharacterinformation.md +++ b/markdown/bitburner.singularity.getcharacterinformation.md @@ -9,7 +9,7 @@ > use getPlayer > -SF4.1 - Returns an object with various information about your character. +Returns an object with various information about your character. Signature: @@ -24,5 +24,5 @@ Object with various information about your character. ## Remarks -RAM cost: 0.5 GB +RAM cost: 0.5 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md index b4ecc6d88..5d43bce39 100644 --- a/markdown/bitburner.singularity.getcompanyfavor.md +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -4,7 +4,7 @@ ## Singularity.getCompanyFavor() method -SF4.2 - Get company favor. +Get company favor. Signature: @@ -26,7 +26,7 @@ Amount of favor you have at the specified company. ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB \* 16/4/1 This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md index be718408c..84582a29a 100644 --- a/markdown/bitburner.singularity.getcompanyfavorgain.md +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -4,7 +4,7 @@ ## Singularity.getCompanyFavorGain() method -SF4.2 - Get company favor gain. +Get company favor gain. Signature: @@ -26,7 +26,7 @@ Amount of favor you gain at the specified company when you reset by installing A ## Remarks -RAM cost: 0.75 GB +RAM cost: 0.75 GB \* 16/4/1 This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md index 985e28cba..d0e0755ce 100644 --- a/markdown/bitburner.singularity.getcompanyrep.md +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -4,7 +4,7 @@ ## Singularity.getCompanyRep() method -SF4.2 - Get company reputation. +Get company reputation. Signature: @@ -26,7 +26,7 @@ Amount of reputation you have at the specified company. ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB \* 16/4/1 This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index 5a9b7f23f..a332e1e66 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -4,7 +4,7 @@ ## Singularity.getCrimeChance() method -SF4.3 - Get chance to successfully commit a crime. +Get chance to successfully commit a crime. Signature: @@ -26,7 +26,7 @@ Chance of success at commiting the specified crime. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 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 6d0dd6b4a..01ace9598 100644 --- a/markdown/bitburner.singularity.getcrimestats.md +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -4,7 +4,7 @@ ## Singularity.getCrimeStats() method -SF4.3 - Get stats related to a crime. +Get stats related to a crime. Signature: @@ -26,7 +26,7 @@ The stats of the crime. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 Returns the stats of the crime. diff --git a/markdown/bitburner.singularity.getcurrentserver.md b/markdown/bitburner.singularity.getcurrentserver.md index 15bd648c5..32aab3285 100644 --- a/markdown/bitburner.singularity.getcurrentserver.md +++ b/markdown/bitburner.singularity.getcurrentserver.md @@ -4,7 +4,7 @@ ## Singularity.getCurrentServer() method -SF4.1 - Get the current server. +Get the current server. Signature: @@ -19,5 +19,5 @@ Name of the current server. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md index fec17c441..abdfc46f7 100644 --- a/markdown/bitburner.singularity.getfactionfavor.md +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -4,7 +4,7 @@ ## Singularity.getFactionFavor() method -SF4.2 - Get faction favor. +Get faction favor. Signature: @@ -26,7 +26,7 @@ Amount of favor you have for the specified faction. ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB \* 16/4/1 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 c96e7e0fe..ca8d8b384 100644 --- a/markdown/bitburner.singularity.getfactionfavorgain.md +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -4,7 +4,7 @@ ## Singularity.getFactionFavorGain() method -SF4.2 - Get faction favor gain. +Get faction favor gain. Signature: @@ -26,7 +26,7 @@ Amount of favor you will gain for the specified faction when you reset by instal ## Remarks -RAM cost: 0.75 GB +RAM cost: 0.75 GB \* 16/4/1 This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md index aad3f0ab8..5c2f0b661 100644 --- a/markdown/bitburner.singularity.getfactionrep.md +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -4,7 +4,7 @@ ## Singularity.getFactionRep() method -SF4.2 - Get faction reputation. +Get faction reputation. Signature: @@ -26,7 +26,7 @@ Amount of reputation you have for the specified faction. ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB \* 16/4/1 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 734f71b8c..34cd7f36f 100644 --- a/markdown/bitburner.singularity.getownedaugmentations.md +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -4,7 +4,7 @@ ## Singularity.getOwnedAugmentations() method -SF4.3 - Get a list of owned augmentation. +Get a list of owned augmentation. Signature: @@ -26,7 +26,7 @@ Array containing the names (as strings) of all Augmentations you have. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function returns an array containing the names (as strings) of all Augmentations you have. diff --git a/markdown/bitburner.singularity.getstats.md b/markdown/bitburner.singularity.getstats.md index ba8026efb..2dfa56982 100644 --- a/markdown/bitburner.singularity.getstats.md +++ b/markdown/bitburner.singularity.getstats.md @@ -9,7 +9,7 @@ > use getPlayer > -SF4.1 - Returns an object with the Player’s stats. +Returns an object with the Player’s stats. Signature: @@ -24,7 +24,7 @@ Object with the Player’s stats. ## Remarks -RAM cost: 0.5 GB +RAM cost: 0.5 GB \* 16/4/1 ## Example diff --git a/markdown/bitburner.singularity.getupgradehomecorescost.md b/markdown/bitburner.singularity.getupgradehomecorescost.md index 1c268ccb3..1c1ee5944 100644 --- a/markdown/bitburner.singularity.getupgradehomecorescost.md +++ b/markdown/bitburner.singularity.getupgradehomecorescost.md @@ -4,7 +4,7 @@ ## Singularity.getUpgradeHomeCoresCost() method -SF4.2 - Get the price of upgrading home cores. +Get the price of upgrading home cores. Signature: @@ -19,7 +19,7 @@ Cost of upgrading the player’s home computer cores. ## Remarks -RAM cost: 1.5 GB +RAM cost: 1.5 GB \* 16/4/1 Returns the cost of upgrading the player’s home computer cores. diff --git a/markdown/bitburner.singularity.getupgradehomeramcost.md b/markdown/bitburner.singularity.getupgradehomeramcost.md index 0531d4d1f..5e250742f 100644 --- a/markdown/bitburner.singularity.getupgradehomeramcost.md +++ b/markdown/bitburner.singularity.getupgradehomeramcost.md @@ -4,7 +4,7 @@ ## Singularity.getUpgradeHomeRamCost() method -SF4.2 - Get the price of upgrading home RAM. +Get the price of upgrading home RAM. Signature: @@ -19,7 +19,7 @@ Cost of upgrading the player’s home computer RAM. ## Remarks -RAM cost: 1.5 GB +RAM cost: 1.5 GB \* 16/4/1 Returns the cost of upgrading the player’s home computer RAM. diff --git a/markdown/bitburner.singularity.gotolocation.md b/markdown/bitburner.singularity.gotolocation.md index 5ca8ddfb7..6f40592e4 100644 --- a/markdown/bitburner.singularity.gotolocation.md +++ b/markdown/bitburner.singularity.gotolocation.md @@ -4,7 +4,7 @@ ## Singularity.goToLocation() method -SF4.3 - Go to a location. +Go to a location. Signature: @@ -26,7 +26,7 @@ True if the player was moved there, false otherwise. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 Move the player to a specific location. diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md index f8cd8b045..7b57d4736 100644 --- a/markdown/bitburner.singularity.gymworkout.md +++ b/markdown/bitburner.singularity.gymworkout.md @@ -4,12 +4,12 @@ ## Singularity.gymWorkout() method -SF4.1 - Workout at the gym. +Workout at the gym. Signature: ```typescript -gymWorkout(gymName: string, stat: string): boolean; +gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; ``` ## Parameters @@ -18,6 +18,7 @@ gymWorkout(gymName: string, stat: string): boolean; | --- | --- | --- | | gymName | string | Name of gym. You must be in the correct city for whatever gym you specify. | | stat | string | The stat you want to train. | +| focus | boolean | Acquire player focus on this gym workout. Optional. Defaults to true. | Returns: @@ -27,7 +28,7 @@ True if actions is successfully started, false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. diff --git a/markdown/bitburner.singularity.hospitalize.md b/markdown/bitburner.singularity.hospitalize.md index 033da23d5..299c2d43c 100644 --- a/markdown/bitburner.singularity.hospitalize.md +++ b/markdown/bitburner.singularity.hospitalize.md @@ -4,7 +4,7 @@ ## Singularity.hospitalize() method -SF4.1 - Hospitalize the player. +Hospitalize the player. Signature: @@ -19,5 +19,5 @@ The cost of the hospitalization. ## Remarks -RAM cost: 0.25 GB +RAM cost: 0.25 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md index 7596ca6e8..a3c23f337 100644 --- a/markdown/bitburner.singularity.installaugmentations.md +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -4,7 +4,7 @@ ## Singularity.installAugmentations() method -SF4.3 - Install your purchased augmentations. +Install your purchased augmentations. Signature: @@ -24,7 +24,7 @@ void ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function will automatically install your Augmentations, resetting the game as usual. diff --git a/markdown/bitburner.singularity.installbackdoor.md b/markdown/bitburner.singularity.installbackdoor.md index 103fa9062..3d85dac5c 100644 --- a/markdown/bitburner.singularity.installbackdoor.md +++ b/markdown/bitburner.singularity.installbackdoor.md @@ -4,7 +4,7 @@ ## Singularity.installBackdoor() method -SF4.1 - Run the backdoor command in the terminal. +Run the backdoor command in the terminal. Signature: @@ -15,9 +15,9 @@ installBackdoor(): Promise; Promise<void> -True if the installation was successful. +Promise waiting for the installation to finish. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md index 434947358..d6b88caf1 100644 --- a/markdown/bitburner.singularity.isbusy.md +++ b/markdown/bitburner.singularity.isbusy.md @@ -4,7 +4,7 @@ ## Singularity.isBusy() method -SF4.1 - Check if the player is busy. +Check if the player is busy. Signature: @@ -19,7 +19,7 @@ True if the player is currently performing an ‘action’, false otherwise. ## Remarks -RAM cost: 0.5 GB +RAM cost: 0.5 GB \* 16/4/1 Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. diff --git a/markdown/bitburner.singularity.isfocused.md b/markdown/bitburner.singularity.isfocused.md index b3afd2582..4f65c51ce 100644 --- a/markdown/bitburner.singularity.isfocused.md +++ b/markdown/bitburner.singularity.isfocused.md @@ -4,7 +4,7 @@ ## Singularity.isFocused() method -SF4.2 - Check if the player is focused. +Check if the player is focused. Signature: @@ -19,5 +19,5 @@ True if the player is focused. ## Remarks -RAM cost: 0.1 GB +RAM cost: 0.1 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md index 75dace55f..4fe141f51 100644 --- a/markdown/bitburner.singularity.joinfaction.md +++ b/markdown/bitburner.singularity.joinfaction.md @@ -4,7 +4,7 @@ ## Singularity.joinFaction() method -SF4.2 - Join a faction. +Join a faction. Signature: @@ -26,7 +26,7 @@ True if player joined the faction, and false otherwise. ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 This function will automatically accept an invitation from a faction and join it. diff --git a/markdown/bitburner.singularity.manualhack.md b/markdown/bitburner.singularity.manualhack.md index d638222eb..f36865fac 100644 --- a/markdown/bitburner.singularity.manualhack.md +++ b/markdown/bitburner.singularity.manualhack.md @@ -4,7 +4,7 @@ ## Singularity.manualHack() method -SF4.1 - Run the hack command in the terminal. +Run the hack command in the terminal. Signature: @@ -19,5 +19,5 @@ Amount of money stolen by manual hacking. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index 9d3a89d47..5a3b11db5 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -14,57 +14,57 @@ export interface Singularity ## Remarks -This API requires Source-File 4 level 1 / 2 / 3 to use. +This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels. ## Methods | Method | Description | | --- | --- | -| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | SF4.2 - Apply for a job at a company. | -| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | SF4.2 - List all current faction invitations. | -| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | SF4.3 - Commit a crime. | -| [connect(hostname)](./bitburner.singularity.connect.md) | SF4.1 - Connect to a server. | -| [createProgram(program)](./bitburner.singularity.createprogram.md) | SF4.3 - Create a program. | -| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | SF4.3 - Donate to a faction. | -| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | SF4.3 - Get the price and reputation of an augmentation. | -| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | SF4.3 - Get the pre-requisite of an augmentation. | -| [getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) | SF4.3 - Get price of an augmentation. | -| [getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) | SF4.3 - Get reputation requirement of an augmentation. | -| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | SF4.3 - Get a list of augmentation available from a faction. | -| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | SF4.3 - Get the stats of an augmentation. | -| [getCharacterInformation()](./bitburner.singularity.getcharacterinformation.md) | SF4.1 - Returns an object with various information about your character. | -| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | SF4.2 - Get company favor. | -| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | SF4.2 - Get company favor gain. | -| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | SF4.2 - Get company reputation. | -| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | SF4.3 - Get chance to successfully commit a crime. | -| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | SF4.3 - Get stats related to a crime. | -| [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | SF4.1 - Get the current server. | -| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | SF4.2 - Get faction favor. | -| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | SF4.2 - Get faction favor gain. | -| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | SF4.2 - Get faction reputation. | -| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | SF4.3 - Get a list of owned augmentation. | -| [getStats()](./bitburner.singularity.getstats.md) | SF4.1 - Returns an object with the Player’s stats. | -| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | SF4.2 - Get the price of upgrading home cores. | -| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | SF4.2 - Get the price of upgrading home RAM. | -| [goToLocation(locationName)](./bitburner.singularity.gotolocation.md) | SF4.3 - Go to a location. | -| [gymWorkout(gymName, stat)](./bitburner.singularity.gymworkout.md) | SF4.1 - Workout at the gym. | -| [hospitalize()](./bitburner.singularity.hospitalize.md) | SF4.1 - Hospitalize the player. | -| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | SF4.3 - Install your purchased augmentations. | -| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | SF4.1 - Run the backdoor command in the terminal. | -| [isBusy()](./bitburner.singularity.isbusy.md) | SF4.1 - Check if the player is busy. | -| [isFocused()](./bitburner.singularity.isfocused.md) | SF4.2 - Check if the player is focused. | -| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | SF4.2 - Join a faction. | -| [manualHack()](./bitburner.singularity.manualhack.md) | SF4.1 - Run the hack command in the terminal. | -| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | SF4.3 - Purchase an augmentation | -| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | SF4.1 - Purchase a program from the dark web. | -| [purchaseTor()](./bitburner.singularity.purchasetor.md) | SF4.1 - Purchase the TOR router. | -| [setFocus(focus)](./bitburner.singularity.setfocus.md) | SF4.2 - Set the players focus. | -| [softReset(cbScript)](./bitburner.singularity.softreset.md) | SF4.3 - Soft reset the game. | -| [stopAction()](./bitburner.singularity.stopaction.md) | SF4.1 - Stop the current action. | -| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | SF4.1 - Travel to another city. | -| [universityCourse(universityName, courseName)](./bitburner.singularity.universitycourse.md) | SF4.1 - Take university class. | -| [upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) | SF4.2 - Upgrade home computer cores. | -| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | SF4.2 - Upgrade home computer RAM. | -| [workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) | SF4.2 - Work for a company. | -| [workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) | SF4.2 - Work for a faction. | +| [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. | +| [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. | +| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | +| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. | +| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation of an augmentation. | +| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. | +| [getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) | Get price of an augmentation. | +| [getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) | Get reputation requirement 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. | +| [getCharacterInformation()](./bitburner.singularity.getcharacterinformation.md) | Returns an object with various information about your character. | +| [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. | +| [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | Get the current server. | +| [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. | +| [getStats()](./bitburner.singularity.getstats.md) | Returns an object with the Player’s stats. | +| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | Get the price of upgrading home cores. | +| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. | +| [goToLocation(locationName)](./bitburner.singularity.gotolocation.md) | Go to a location. | +| [gymWorkout(gymName, stat, focus)](./bitburner.singularity.gymworkout.md) | Workout at the gym. | +| [hospitalize()](./bitburner.singularity.hospitalize.md) | Hospitalize the player. | +| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | Install your purchased augmentations. | +| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | Run the backdoor command in the terminal. | +| [isBusy()](./bitburner.singularity.isbusy.md) | Check if the player is busy. | +| [isFocused()](./bitburner.singularity.isfocused.md) | Check if the player is focused. | +| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | Join a faction. | +| [manualHack()](./bitburner.singularity.manualhack.md) | Run the hack command in the terminal. | +| [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. | +| [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. | +| [softReset(cbScript)](./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, focus)](./bitburner.singularity.universitycourse.md) | Take university class. | +| [upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) | Upgrade home computer cores. | +| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | Upgrade home computer RAM. | +| [workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) | Work for a company. | +| [workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) | Work for a faction. | diff --git a/markdown/bitburner.singularity.purchaseaugmentation.md b/markdown/bitburner.singularity.purchaseaugmentation.md index 78e546efd..b7d8645a4 100644 --- a/markdown/bitburner.singularity.purchaseaugmentation.md +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -4,7 +4,7 @@ ## Singularity.purchaseAugmentation() method -SF4.3 - Purchase an augmentation +Purchase an augmentation Signature: @@ -27,7 +27,7 @@ True if the Augmentation is successfully purchased, and false otherwise. ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 This function will try to purchase the specified Augmentation through the given Faction. diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md index 7a6a6268a..3f1e7c4a0 100644 --- a/markdown/bitburner.singularity.purchaseprogram.md +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -4,7 +4,7 @@ ## Singularity.purchaseProgram() method -SF4.1 - Purchase a program from the dark web. +Purchase a program from the dark web. Signature: @@ -26,7 +26,7 @@ True if the specified program is purchased, and false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. diff --git a/markdown/bitburner.singularity.purchasetor.md b/markdown/bitburner.singularity.purchasetor.md index 413913ff8..e93e63491 100644 --- a/markdown/bitburner.singularity.purchasetor.md +++ b/markdown/bitburner.singularity.purchasetor.md @@ -4,7 +4,7 @@ ## Singularity.purchaseTor() method -SF4.1 - Purchase the TOR router. +Purchase the TOR router. Signature: @@ -19,7 +19,7 @@ True if actions is successful, false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. diff --git a/markdown/bitburner.singularity.setfocus.md b/markdown/bitburner.singularity.setfocus.md index 95aaf1e45..febb40905 100644 --- a/markdown/bitburner.singularity.setfocus.md +++ b/markdown/bitburner.singularity.setfocus.md @@ -4,7 +4,7 @@ ## Singularity.setFocus() method -SF4.2 - Set the players focus. +Set the players focus. Signature: @@ -26,5 +26,5 @@ True if the focus was changed. ## Remarks -RAM cost: 0.1 GB +RAM cost: 0.1 GB \* 16/4/1 diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md index e5d1b0c1b..f55ac6dc9 100644 --- a/markdown/bitburner.singularity.softreset.md +++ b/markdown/bitburner.singularity.softreset.md @@ -4,7 +4,7 @@ ## Singularity.softReset() method -SF4.3 - Soft reset the game. +Soft reset the game. Signature: @@ -24,7 +24,7 @@ void ## Remarks -RAM cost: 5 GB +RAM cost: 5 GB \* 16/4/1 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 d3c7798b1..c2daafc53 100644 --- a/markdown/bitburner.singularity.stopaction.md +++ b/markdown/bitburner.singularity.stopaction.md @@ -4,7 +4,7 @@ ## Singularity.stopAction() method -SF4.1 - Stop the current action. +Stop the current action. Signature: @@ -19,7 +19,7 @@ True if the player’s action was ended, false if the player was not performing ## Remarks -RAM cost: 1 GB +RAM cost: 1 GB \* 16/4/1 This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action. diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md index bc8e961b0..fe5f6a3ee 100644 --- a/markdown/bitburner.singularity.traveltocity.md +++ b/markdown/bitburner.singularity.traveltocity.md @@ -4,7 +4,7 @@ ## Singularity.travelToCity() method -SF4.1 - Travel to another city. +Travel to another city. Signature: @@ -26,7 +26,7 @@ True if actions is successful, false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md index b66ab959f..e68810431 100644 --- a/markdown/bitburner.singularity.universitycourse.md +++ b/markdown/bitburner.singularity.universitycourse.md @@ -4,12 +4,12 @@ ## Singularity.universityCourse() method -SF4.1 - Take university class. +Take university class. Signature: ```typescript -universityCourse(universityName: string, courseName: string): boolean; +universityCourse(universityName: string, courseName: string, focus?: boolean): boolean; ``` ## Parameters @@ -18,6 +18,7 @@ universityCourse(universityName: string, courseName: string): boolean; | --- | --- | --- | | universityName | string | Name of university. You must be in the correct city for whatever university you specify. | | courseName | string | Name of course. | +| focus | boolean | Acquire player focus on this class. Optional. Defaults to true. | Returns: @@ -27,7 +28,7 @@ True if actions is successfully started, false otherwise. ## Remarks -RAM cost: 2 GB +RAM cost: 2 GB \* 16/4/1 This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. diff --git a/markdown/bitburner.singularity.upgradehomecores.md b/markdown/bitburner.singularity.upgradehomecores.md index b5c7740d5..4351e56b5 100644 --- a/markdown/bitburner.singularity.upgradehomecores.md +++ b/markdown/bitburner.singularity.upgradehomecores.md @@ -4,7 +4,7 @@ ## Singularity.upgradeHomeCores() method -SF4.2 - Upgrade home computer cores. +Upgrade home computer cores. Signature: @@ -19,7 +19,7 @@ True if the player’s home computer cores is successfully upgraded, and false o ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 This function will upgrade amount of cores on the player’s home computer. The cost is the same as if you were to do it manually. diff --git a/markdown/bitburner.singularity.upgradehomeram.md b/markdown/bitburner.singularity.upgradehomeram.md index 1b90ff5ed..f8f0e700d 100644 --- a/markdown/bitburner.singularity.upgradehomeram.md +++ b/markdown/bitburner.singularity.upgradehomeram.md @@ -4,7 +4,7 @@ ## Singularity.upgradeHomeRam() method -SF4.2 - Upgrade home computer RAM. +Upgrade home computer RAM. Signature: @@ -19,7 +19,7 @@ True if the player’s home computer RAM is successfully upgraded, and false oth ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually. diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md index 8a613e75f..e4ac7754c 100644 --- a/markdown/bitburner.singularity.workforcompany.md +++ b/markdown/bitburner.singularity.workforcompany.md @@ -4,7 +4,7 @@ ## Singularity.workForCompany() method -SF4.2 - Work for a company. +Work for a company. Signature: @@ -27,7 +27,7 @@ True if the player starts working, and false otherwise. ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 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. diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md index aaaac2523..c4b76d094 100644 --- a/markdown/bitburner.singularity.workforfaction.md +++ b/markdown/bitburner.singularity.workforfaction.md @@ -4,7 +4,7 @@ ## Singularity.workForFaction() method -SF4.2 - Work for a faction. +Work for a faction. Signature: @@ -28,7 +28,7 @@ True if the player starts working, and false otherwise. ## Remarks -RAM cost: 3 GB +RAM cost: 3 GB \* 16/4/1 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. diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md index 444a63653..98a3ebda9 100644 --- a/markdown/bitburner.stockorder.md +++ b/markdown/bitburner.stockorder.md @@ -6,6 +6,8 @@ Return value of [getOrders](./bitburner.tix.getorders.md) +Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) + Signature: ```typescript diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md index c07a84caf..f7d5e6eda 100644 --- a/markdown/bitburner.stockorderobject.md +++ b/markdown/bitburner.stockorderobject.md @@ -16,8 +16,8 @@ export interface StockOrderObject | Property | Type | Description | | --- | --- | --- | -| [position](./bitburner.stockorderobject.position.md) | string | Order position | +| [position](./bitburner.stockorderobject.position.md) | [PositionTypes](./bitburner.positiontypes.md) | Order position | | [price](./bitburner.stockorderobject.price.md) | number | Price per share | | [shares](./bitburner.stockorderobject.shares.md) | number | Number of shares | -| [type](./bitburner.stockorderobject.type.md) | string | Order type | +| [type](./bitburner.stockorderobject.type.md) | [OrderTypes](./bitburner.ordertypes.md) | Order type | diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md index 719917039..9f6aac1de 100644 --- a/markdown/bitburner.stockorderobject.position.md +++ b/markdown/bitburner.stockorderobject.position.md @@ -9,5 +9,5 @@ Order position Signature: ```typescript -position: string; +position: PositionTypes; ``` diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md index f5ce9fa29..59c3258ef 100644 --- a/markdown/bitburner.stockorderobject.type.md +++ b/markdown/bitburner.stockorderobject.type.md @@ -9,5 +9,5 @@ Order type Signature: ```typescript -type: string; +type: OrderTypes; ``` diff --git a/markdown/bitburner.tix.getorders.md b/markdown/bitburner.tix.getorders.md index a66b68f71..04184a956 100644 --- a/markdown/bitburner.tix.getorders.md +++ b/markdown/bitburner.tix.getorders.md @@ -19,7 +19,7 @@ Object containing information for all the Limit and Stop Orders you have in the ## Remarks -RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure: +RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. For each symbol you have a position in, the returned object will have a key with that symbol's name. The object's properties are each an array of [StockOrderObject](./bitburner.stockorderobject.md) The object has the following structure: ```ts { diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index f8212c514..8fc99aaaf 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1,3 +1,8 @@ +/** + * @public + */ +type FilenameOrPID = number | string; + /** * @public */ @@ -1041,7 +1046,7 @@ export interface NetscriptPort { * * @returns The data popped off the queue if it was full. */ - write(value: string|number): null|string|number; + write(value: string | number): null | string | number; /** * Attempt to write data to the port. @@ -1050,7 +1055,7 @@ export interface NetscriptPort { * * @returns True if the data was added to the port, false if the port was full */ - tryWrite(value: string|number): boolean; + tryWrite(value: string | number): boolean; /** * Shift an element out of the port. @@ -1061,7 +1066,7 @@ export interface NetscriptPort { * If the port is empty, then the string “NULL PORT DATA” will be returned. * @returns the data read. */ - read(): string|number; + read(): string | number; /** * Retrieve the first element from the port without removing it. @@ -1073,7 +1078,7 @@ export interface NetscriptPort { * the port is empty, the string “NULL PORT DATA” will be returned. * @returns the data read */ - peek(): string|number; + peek(): string | number; /** * Check if the port is full. @@ -6011,7 +6016,7 @@ export interface NS extends Singularity { * to convert from script to text file, or vice versa. * * This function can also be used to rename files. - * + * * @param host - Host of target server. * @param source - Filename of the source file. * @param destination - Filename of the destination file.