felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 07:18:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

merge dev

Browse Source
This commit is contained in:
Olivier Gagnon
2021-12-03 15:35:45 -05:00
parent faa9b87733 798c9867a7
commit d4ebc46a19
472 changed files with 8880 additions and 1304 deletions
Download Patch File Download Diff File Expand all files Collapse all files

214
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@@ -669,8 +669,13 @@ export interface GangOtherInfoObject {
* @public
*/
export interface GangOtherInfo {
/** Stock Symbol */
[key: string]: GangOtherInfoObject[];
"Slum Snakes": GangOtherInfoObject;
Tetrads: GangOtherInfoObject;
"The Syndicate": GangOtherInfoObject;
"The Dark Army": GangOtherInfoObject;
"Speakers for the Dead": GangOtherInfoObject;
NiteSec: GangOtherInfoObject;
"The Black Hand": GangOtherInfoObject;
}
/**
@@ -1235,12 +1240,11 @@ export interface TIX {
*/
export interface Singularity {
/**
* Take university class.
* SF4.1 - Take university class.
*
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* This function will automatically set you to start taking a course at a university.
* If you are already in the middle of some “working” action (such as working at a
@@ -1257,12 +1261,11 @@ export interface Singularity {
universityCourse(universityName: string, courseName: string): boolean;
/**
* Workout at the gym.
* SF4.1 - Workout at the gym.
*
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
* This function will automatically set you to start working out at a gym to train
* a particular stat. If you are already in the middle of some “working” action
@@ -1279,11 +1282,10 @@ export interface Singularity {
gymWorkout(gymName: string, stat: string): boolean;
/**
* Travel to another city.
* SF4.1 - Travel to another city.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* This function allows the player to travel to any city. The cost for using this
* function is the same as the cost for traveling through the Travel Agency.
@@ -1294,11 +1296,10 @@ export interface Singularity {
travelToCity(city: string): boolean;
/**
* Purchase the TOR router.
* SF4.1 - Purchase the TOR router.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* This function allows you to automatically purchase a TOR router. The cost for
* purchasing a TOR router using this function is the same as if you were to
@@ -1309,11 +1310,10 @@ export interface Singularity {
purchaseTor(): boolean;
/**
* Purchase a program from the dark web.
* SF4.1 - Purchase a program from the dark web.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* This function allows you to automatically purchase programs. You MUST have a
* TOR router in order to use this function. The cost of purchasing programs
@@ -1330,11 +1330,10 @@ export interface Singularity {
purchaseProgram(programName: string): boolean;
/**
* Check if the player is busy.
* SF4.1 - Check if the player is busy.
* @remarks
* RAM cost: 0.5 GB
*
* Singularity - Level 1
*
* Returns a boolean indicating whether or not the player is currently performing an
* ‘action’. These actions include working for a company/faction, studying at a univeristy,
@@ -1345,11 +1344,10 @@ export interface Singularity {
isBusy(): boolean;
/**
* Stop the current action.
* SF4.1 - Stop the current action.
* @remarks
* RAM cost: 1 GB
*
* Singularity - Level 1
*
* This function is used to end whatever ‘action’ the player is currently performing.
* The player will receive whatever money/experience/etc. he has earned from that action.
@@ -1369,11 +1367,10 @@ export interface Singularity {
stopAction(): boolean;
/**
* Upgrade home computer RAM.
* SF4.2 - Upgrade home computer RAM.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* This function will upgrade amount of RAM on the player’s home computer. The cost is
* the same as if you were to do it manually.
@@ -1385,11 +1382,10 @@ export interface Singularity {
upgradeHomeRam(): boolean;
/**
* Upgrade home computer cores.
* SF4.2 - Upgrade home computer cores.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* 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.
@@ -1401,11 +1397,10 @@ export interface Singularity {
upgradeHomeCores(): boolean;
/**
* Get the price of upgrading home RAM.
* SF4.2 - Get the price of upgrading home RAM.
* @remarks
* RAM cost: 1.5 GB
*
* Singularity - Level 2
*
* Returns the cost of upgrading the player’s home computer RAM.
*
@@ -1414,11 +1409,10 @@ export interface Singularity {
getUpgradeHomeRamCost(): number;
/**
* Get the price of upgrading home cores.
* SF4.2 - Get the price of upgrading home cores.
* @remarks
* RAM cost: 1.5 GB
*
* Singularity - Level 2
*
* Returns the cost of upgrading the player’s home computer cores.
*
@@ -1427,11 +1421,10 @@ export interface Singularity {
getUpgradeHomeCoresCost(): number;
/**
* Work for a company.
* SF4.2 - Work for a company.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* This function will automatically set you to start working at the company
* at which you are employed. If you are already in the middle of some “working”
@@ -1458,11 +1451,10 @@ export interface Singularity {
workForCompany(companyName?: string): boolean;
/**
* Apply for a job at a company.
* SF4.2 - Apply for a job at a company.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* This function will automatically try to apply to the specified company
* for a position in the specified field. This function can also be used to
@@ -1480,11 +1472,10 @@ export interface Singularity {
applyToCompany(companyName: string, field: string): boolean;
/**
* Get company reputation.
* SF4.2 - Get company reputation.
* @remarks
* RAM cost: 1 GB
*
* Singularity - Level 2
*
* This function will return the amount of reputation you have at the specified company.
* If the company passed in as an argument is invalid, -1 will be returned.
@@ -1495,11 +1486,10 @@ export interface Singularity {
getCompanyRep(companyName: string): number;
/**
* Get company favor.
* SF4.2 - Get company favor.
* @remarks
* RAM cost: 1 GB
*
* Singularity - Level 2
*
* This function will return the amount of favor you have at the specified company.
* If the company passed in as an argument is invalid, -1 will be returned.
@@ -1510,11 +1500,10 @@ export interface Singularity {
getCompanyFavor(companyName: string): number;
/**
* Get company favor gain.
* SF4.2 - Get company favor gain.
* @remarks
* RAM cost: 0.75 GB
*
* Singularity - Level 2
*
* This function will return the amount of favor you will gain for the specified
* company when you reset by installing Augmentations.
@@ -1525,11 +1514,10 @@ export interface Singularity {
getCompanyFavorGain(companyName: string): number;
/**
* List all current faction invitations.
* SF4.2 - List all current faction invitations.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* Returns an array with the name of all Factions you currently have oustanding invitations from.
*
@@ -1538,11 +1526,10 @@ export interface Singularity {
checkFactionInvitations(): string[];
/**
* Join a faction.
* SF4.2 - Join a faction.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* This function will automatically accept an invitation from a faction and join it.
*
@@ -1552,11 +1539,10 @@ export interface Singularity {
joinFaction(faction: string): boolean;
/**
* Work for a faction.
* SF4.2 - Work for a faction.
* @remarks
* RAM cost: 3 GB
*
* Singularity - Level 2
*
* This function will automatically set you to start working for the specified faction.
* Obviously, you must be a member of the faction or else this function will fail. If
@@ -1584,11 +1570,10 @@ export interface Singularity {
workForFaction(faction: string, workType: string): boolean;
/**
* Get faction reputation.
* SF4.2 - Get faction reputation.
* @remarks
* RAM cost: 1 GB
*
* Singularity - Level 2
*
* This function returns the amount of reputation you have for the specified faction.
*
@@ -1598,11 +1583,10 @@ export interface Singularity {
getFactionRep(faction: string): number;
/**
* Get faction favor.
* SF4.2 - Get faction favor.
* @remarks
* RAM cost: 1 GB
*
* Singularity - Level 2
*
* This function returns the amount of favor you have for the specified faction.
*
@@ -1612,11 +1596,10 @@ export interface Singularity {
getFactionFavor(faction: string): number;
/**
* Get faction favor gain.
* SF4.2 - Get faction favor gain.
* @remarks
* RAM cost: 0.75 GB
*
* Singularity - Level 2
*
* This function returns the amount of favor you will gain for the specified
* faction when you reset by installing Augmentations.
@@ -1627,11 +1610,10 @@ export interface Singularity {
getFactionFavorGain(faction: string): number;
/**
* Donate to a faction.
* SF4.3 - Donate to a faction.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* Attempts to donate money to the specified faction in exchange for reputation.
* Returns true if you successfully donate the money, and false otherwise.
@@ -1643,11 +1625,10 @@ export interface Singularity {
donateToFaction(faction: string, amount: number): boolean;
/**
* Create a program.
* SF4.3 - Create a program.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function will automatically set you to start working on creating the
* specified program. If you are already in the middle of some “working” action
@@ -1678,11 +1659,10 @@ export interface Singularity {
createProgram(program: string): boolean;
/**
* Commit a crime.
* SF4.3 - Commit a crime.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function is used to automatically attempt to commit crimes.
* If you are already in the middle of some ‘working’ action (such
@@ -1706,11 +1686,10 @@ export interface Singularity {
commitCrime(crime: string): number;
/**
* Get chance to successfully commit a crime.
* SF4.3 - Get chance to successfully commit a crime.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function returns your chance of success at commiting the specified crime.
*
@@ -1720,11 +1699,10 @@ export interface Singularity {
getCrimeChance(crime: string): number;
/**
* Get stats related to a crime.
* SF4.3 - Get stats related to a crime.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* Returns the stats of the crime.
*
@@ -1734,11 +1712,10 @@ export interface Singularity {
getCrimeStats(crime: string): CrimeStats;
/**
* Get a list of owned augmentation.
* SF4.3 - Get a list of owned augmentation.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function returns an array containing the names (as strings) of all Augmentations you have.
*
@@ -1748,24 +1725,10 @@ export interface Singularity {
getOwnedAugmentations(purchased?: boolean): string[];
/**
* Get a list of acquired Source-Files.
* SF4.3 - Get a list of augmentation available from a faction.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* Returns an array of source files
*
* @returns Array containing an object with number and level of the source file.
*/
getOwnedSourceFiles(): SourceFileLvl[];
/**
* Get a list of augmentation available from a faction.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* Returns an array containing the names (as strings) of all Augmentations
* that are available from the specified faction.
@@ -1776,11 +1739,10 @@ export interface Singularity {
getAugmentationsFromFaction(faction: string): string[];
/**
* Get the pre-requisite of an augmentation.
* SF4.3 - Get the pre-requisite of an augmentation.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation.
* If there are no prerequisites, a blank array is returned.
@@ -1791,12 +1753,11 @@ export interface Singularity {
getAugmentationPrereq(augName: string): string[];
/**
* @deprecated
* Get the price and reputation of an augmentation.
* SF4.3 - Get the price and reputation of an augmentation.
* @deprecated use getAugmentationPrice getAugmentationRepCost
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* 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
@@ -1812,11 +1773,10 @@ export interface Singularity {
getAugmentationCost(augName: string): [number, number];
/**
* Get price of an augmentation.
* SF4.3 - Get price of an augmentation.
* @remarks
* RAM cost: 2.5 GB
*
* Singularity - Level 3
*
* @param augName - Name of Augmentation.
* @returns Price of the augmentation.
@@ -1824,11 +1784,10 @@ export interface Singularity {
getAugmentationPrice(augName: string): number;
/**
* Get reputation requirement of an augmentation.
* SF4.3 - Get reputation requirement of an augmentation.
* @remarks
* RAM cost: 2.5 GB
*
* Singularity - Level 3
*
* @param augName - Name of Augmentation.
* @returns Reputation requirement of the augmentation.
@@ -1836,11 +1795,10 @@ export interface Singularity {
getAugmentationRepReq(augName: string): number;
/**
* Purchase an augmentation
* SF4.3 - Purchase an augmentation
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function will try to purchase the specified Augmentation through the given Faction.
*
@@ -1853,11 +1811,10 @@ export interface Singularity {
purchaseAugmentation(faction: string, augmentation: string): boolean;
/**
* Get the stats of an augmentation.
* SF4.3 - Get the stats of an augmentation.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function returns augmentation stats.
*
@@ -1867,11 +1824,10 @@ export interface Singularity {
getAugmentationStats(name: string): AugmentationStats;
/**
* Install your purchased augmentations.
* SF4.3 - Install your purchased augmentations.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function will automatically install your Augmentations, resetting the game as usual.
*
@@ -1880,13 +1836,12 @@ export interface Singularity {
installAugmentations(cbScript?: string): void;
/**
* @deprecated
* Returns an object with the Player’s stats.
* SF4.1 - Returns an object with the Player’s stats.
* @deprecated use getPlayer
*
* @remarks
* RAM cost: 0.5 GB
*
* Singularity - Level 1
*
* @example
* ```ts
@@ -1898,35 +1853,32 @@ export interface Singularity {
getStats(): PlayerSkills;
/**
* @deprecated
* Returns an object with various information about your character.
* SF4.1 - Returns an object with various information about your character.
* @deprecated use getPlayer
*
* @remarks
* RAM cost: 0.5 GB
*
* Singularity - Level 1
*
* @returns Object with various information about your character.
*/
getCharacterInformation(): CharacterInfo;
/**
* Hospitalize the player.
* SF4.1 - Hospitalize the player.
* @remarks
* RAM cost: 0.25 GB
*
* Singularity - Level 1
*
* @returns The cost of the hospitalization.
*/
hospitalize(): number;
/**
* Soft reset the game.
* SF4.3 - Soft reset the game.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* This function will perform a reset even if you don’t have any augmentation installed.
*
@@ -1935,11 +1887,10 @@ export interface Singularity {
softReset(cbScript: string): void;
/**
* Go to a location.
* SF4.3 - Go to a location.
* @remarks
* RAM cost: 5 GB
*
* Singularity - Level 3
*
* Move the player to a specific location.
*
@@ -1949,22 +1900,20 @@ export interface Singularity {
goToLocation(locationName: string): boolean;
/**
* Get the current server.
* SF4.1 - Get the current server.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* @returns Name of the current server.
*/
getCurrentServer(): string;
/**
* Connect to a server.
* SF4.1 - Connect to a server.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.
*
@@ -1973,26 +1922,42 @@ export interface Singularity {
connect(hostname: string): boolean;
/**
* Run the hack command in the terminal.
* SF4.1 - Run the hack command in the terminal.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* @returns Amount of money stolen by manual hacking.
*/
manualHack(): Promise<number>;
/**
* Run the backdoor command in the terminal.
* SF4.1 - Run the backdoor command in the terminal.
* @remarks
* RAM cost: 2 GB
*
* Singularity - Level 1
*
* @returns True if the installation was successful.
*/
installBackdoor(): Promise<void>;
/**
* SF4.2 - Check if the player is focused.
* @remarks
* RAM cost: 0.1 GB
*
*
* @returns True if the player is focused.
*/
isFocused(): void;
/**
* SF4.2 - Set the players focus.
* @remarks
* RAM cost: 0.1 GB
*
*/
setFocus(focus: boolean): void;
}
/**
@@ -2799,7 +2764,7 @@ export interface CodingContract {
* @param opts - Optional parameters for configuring function behavior.
* @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.
*/
attempt(answer: string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string;
attempt(answer: string[] | number, filename: string, host?: string, opts?: CodingAttemptOptions): boolean | string;
/**
* Get the type of a coding contract.
@@ -2813,7 +2778,7 @@ export interface CodingContract {
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Name describing the type of problem posed by the Coding Contract.
*/
getContractType(fn: string, host?: string): string;
getContractType(filename: string, host?: string): string;
/**
* Get the description.
@@ -2826,7 +2791,7 @@ export interface CodingContract {
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Contract’s text description.
*/
getDescription(fn: string, host?: string): string;
getDescription(filename: string, host?: string): string;
/**
* Get the input data.
@@ -2837,11 +2802,11 @@ export interface CodingContract {
* Note that this is not the same as the contract’s description.
* This is just the data that the contract wants you to act on in order to solve
*
* @param fn - Filename of the contract.
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns The specified contract’s data;
*/
getData(fn: string, host?: string): string;
getData(filename: string, host?: string): string;
/**
* Get the number of attempt remaining.
@@ -2854,7 +2819,7 @@ export interface CodingContract {
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns How many attempts are remaining for the contract;
*/
getNumTriesRemaining(fn: string, host?: string): number;
getNumTriesRemaining(filename: string, host?: string): number;
}
/**
@@ -2999,7 +2964,7 @@ export interface Gang {
* Get the name of all possible equipment/upgrades you can purchase for your Gang Members.
* This includes Augmentations.
*
* @returns Names of all Equpiment/Augmentations.
* @returns Names of all Equipments/Augmentations.
*/
getEquipmentNames(): string[];
@@ -4390,8 +4355,7 @@ export interface NS extends Singularity {
getServerMinSecurityLevel(host: string): number;
/**
* @deprecated
* DEPRECATED
* @deprecated useless
* @remarks
* RAM cost: 0.1 GB
* Returns the base security level of the target server. This is the security
@@ -4408,8 +4372,7 @@ export interface NS extends Singularity {
getServerBaseSecurityLevel(host: string): number;
/**
* @deprecated
* DEPRECATED
* @deprecated use getServerMaxRam / getServerUsedRam
* @remarks
* RAM cost: 0.1 GB
*
@@ -4540,7 +4503,7 @@ export interface NS extends Singularity {
* RAM cost: 0.3 GB
* @returns info about a running script
*/
getRunningScript(fn: string | number, hostname: string, ...args: (string | number)[]): RunningScript;
getRunningScript(filename: string | number, hostname: string, ...args: (string | number)[]): RunningScript;
/**
* Get cost of purchasing a server.
@@ -5082,6 +5045,17 @@ export interface NS extends Singularity {
*/
getBitNodeMultipliers(): BitNodeMultipliers;
/**
* Get a list of acquired Source-Files.
* @remarks
* RAM cost: 5 GB
*
* Returns an array of source files
*
* @returns Array containing an object with number and level of the source file.
*/
getOwnedSourceFiles(): SourceFileLvl[];
/**
* Get information about the player.
* @returns Player info