Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-22 22:22:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1813 from danielyxie/dev

Browse Source 
many bugfix
This commit is contained in:
hydroflame 2021-12-03 14:12:47 -05:00 committed by GitHub
commit cf11def6b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
67 changed files with 549 additions and 486 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

162
dist/bitburner.d.ts vendored
View File

@ -1236,8 +1236,13 @@ export declare interface GangMemberInfo {
* @public
*/
export declare 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;
}
/**
@ -2621,8 +2626,7 @@ export declare 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
@ -2639,8 +2643,7 @@ export declare interface NS extends Singularity {
getServerBaseSecurityLevel(host: string): number;
/**
* @deprecated
* DEPRECATED
* @deprecated use getServerMaxRam / getServerUsedRam
* @remarks
* RAM cost: 0.1 GB
*
@ -3579,12 +3582,11 @@ export declare interface Server {
*/
export declare 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
@ -3601,12 +3603,11 @@ export declare 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
@ -3623,11 +3624,10 @@ export declare 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.
@ -3638,11 +3638,10 @@ export declare 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
@ -3653,11 +3652,10 @@ export declare 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
@ -3674,11 +3672,10 @@ export declare 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,
@ -3689,11 +3686,10 @@ export declare 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.
@ -3713,11 +3709,10 @@ export declare 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.
@ -3729,11 +3724,10 @@ export declare 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.
@ -3745,11 +3739,10 @@ export declare 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.
*
@ -3758,11 +3751,10 @@ export declare 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.
*
@ -3771,11 +3763,10 @@ export declare 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”
@ -3802,11 +3793,10 @@ export declare 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
@ -3824,11 +3814,10 @@ export declare 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.
@ -3839,11 +3828,10 @@ export declare 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.
@ -3854,11 +3842,10 @@ export declare 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.
@ -3869,11 +3856,10 @@ export declare 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.
*
@ -3882,11 +3868,10 @@ export declare 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.
*
@ -3896,11 +3881,10 @@ export declare 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
@ -3928,11 +3912,10 @@ export declare 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.
*
@ -3942,11 +3925,10 @@ export declare 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.
*
@ -3956,11 +3938,10 @@ export declare 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.
@ -3971,11 +3952,10 @@ export declare 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.
@ -3987,11 +3967,10 @@ export declare 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
@ -4022,11 +4001,10 @@ export declare 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
@ -4050,11 +4028,10 @@ export declare 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.
*
@ -4064,11 +4041,10 @@ export declare 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.
*
@ -4078,11 +4054,10 @@ export declare 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.
*
@ -4092,11 +4067,10 @@ export declare interface Singularity {
getOwnedAugmentations(purchased?: boolean): string[];
/**
* Get a list of augmentation available from a faction.
* SF4.3 - 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.
@ -4107,11 +4081,10 @@ export declare 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.
@ -4122,12 +4095,11 @@ export declare 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
@ -4143,11 +4115,10 @@ export declare 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.
@ -4155,11 +4126,10 @@ export declare 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.
@ -4167,11 +4137,10 @@ export declare 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.
*
@ -4184,11 +4153,10 @@ export declare 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.
*
@ -4198,11 +4166,10 @@ export declare 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.
*
@ -4211,13 +4178,12 @@ export declare 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
@ -4229,35 +4195,32 @@ export declare 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.
*
@ -4266,11 +4229,10 @@ export declare 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.
*
@ -4280,22 +4242,20 @@ export declare 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.
*
@ -4304,44 +4264,40 @@ export declare 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>;
/**
* Check if the player is focused.
* SF4.2 - Check if the player is focused.
* @remarks
* RAM cost: 0.1 GB
*
* Singularity - Level 2
*
* @returns True if the player is focused.
*/
isFocused(): void;
/**
* Set the players focus.
* SF4.2 - Set the players focus.
* @remarks
* RAM cost: 0.1 GB
*
* Singularity - Level 2
*/
setFocus(focus: boolean): void;
}

24
dist/vendor.bundle.js vendored
View File

File diff suppressed because one or more lines are too long

290
input/bitburner.api.json
View File

@ -8083,21 +8083,13 @@
"name": "GangOtherInfo",
"members": [
{
"kind": "IndexSignature",
"canonicalReference": "bitburner!GangOtherInfo:index(1)",
"docComment": "/**\n * Stock Symbol\n */\n",
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#\"Slum Snakes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "[key: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "]: "
"text": "\"Slum Snakes\": "
},
{
"kind": "Reference",
@ -8106,28 +8098,178 @@
},
{
"kind": "Content",
"text": "[]"
"text": ";"
}
],
"isOptional": false,
"releaseTag": "Public",
"name": "\"Slum Snakes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#\"Speakers for the Dead\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "\"Speakers for the Dead\": "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false,
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
"name": "\"Speakers for the Dead\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#\"The Black Hand\":member",
"docComment": "",
"excerptTokens": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
"kind": "Content",
"text": "\"The Black Hand\": "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
]
],
"isOptional": false,
"releaseTag": "Public",
"name": "\"The Black Hand\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#\"The Dark Army\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "\"The Dark Army\": "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"releaseTag": "Public",
"name": "\"The Dark Army\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#\"The Syndicate\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "\"The Syndicate\": "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"releaseTag": "Public",
"name": "\"The Syndicate\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#NiteSec:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "NiteSec: "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"releaseTag": "Public",
"name": "NiteSec",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!GangOtherInfo#Tetrads:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "Tetrads: "
},
{
"kind": "Reference",
"text": "GangOtherInfoObject",
"canonicalReference": "bitburner!GangOtherInfoObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"releaseTag": "Public",
"name": "Tetrads",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
@ -13357,7 +13499,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!NS#getServerBaseSecurityLevel:member(1)",
"docComment": "/**\n * @remarks\n *\n * RAM cost: 0.1 GB Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @deprecated\n *\n * DEPRECATED\n *\n * @param host - Host of target server.\n *\n * @returns Base security level of the target server.\n */\n",
"docComment": "/**\n * @remarks\n *\n * RAM cost: 0.1 GB Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @deprecated\n *\n * useless\n *\n * @param host - Host of target server.\n *\n * @returns Base security level of the target server.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -13665,7 +13807,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 * DEPRECATED\n *\n * @param host - Host of target server.\n *\n * @returns Array with total and used memory on the specified server.\n *\n * @example\n * ```ts\n * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n",
"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 * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19992,7 +20134,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#applyToCompany:member(1)",
"docComment": "/**\n * Apply for a job at a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.\n *\n * This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.\n *\n * @param companyName - Name of company to apply to.\n *\n * @param field - Field to which you want to apply.\n *\n * @returns True if the player successfully get a job/promotion, and false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20051,7 +20193,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#checkFactionInvitations:member(1)",
"docComment": "/**\n * List all current faction invitations.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * Returns an array with the name of all Factions you currently have oustanding invitations from.\n *\n * @returns Array with the name of all Factions you currently have oustanding invitations from.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20079,7 +20221,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#commitCrime:member(1)",
"docComment": "/**\n * Commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n",
"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 seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20123,7 +20265,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#connect:member(1)",
"docComment": "/**\n * Connect to a server.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 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",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20167,7 +20309,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#createProgram:member(1)",
"docComment": "/**\n * Create a program.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns true if you successfully start working on the specified program, and false otherwise.\n *\n * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: * BruteSSH.exe: 50 * FTPCrack.exe: 100 * relaySMTP.exe: 250 * HTTPWorm.exe: 500 * SQLInject.exe: 750 * DeepscanV1.exe: 75 * DeepscanV2.exe: 400 * ServerProfiler.exe: 75 * AutoLink.exe: 25\n *\n * @param program - Name of program to create.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```ts\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n",
"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 * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20211,7 +20353,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#donateToFaction:member(1)",
"docComment": "/**\n * Donate to a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.\n *\n * @param faction - Name of faction to donate to.\n *\n * @param amount - Amount of money to donate.\n *\n * @returns True if the money was donated, and false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20270,7 +20412,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationCost:member(1)",
"docComment": "/**\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\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 * Get the price and reputation of an augmentation.\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 * 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",
"excerptTokens": [
{
"kind": "Content",
@ -20314,7 +20456,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)",
"docComment": "/**\n * Get the pre-requisite of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20358,7 +20500,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationPrice:member(1)",
"docComment": "/**\n * Get price of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Price of the augmentation.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20402,7 +20544,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationRepReq:member(1)",
"docComment": "/**\n * Get reputation requirement of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 2.5 GB\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Reputation requirement of the augmentation.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20446,7 +20588,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationsFromFaction:member(1)",
"docComment": "/**\n * Get a list of augmentation available from a faction.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.\n *\n * @param faction - Name of faction.\n *\n * @returns Array containing the names of all Augmentations.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20490,7 +20632,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getAugmentationStats:member(1)",
"docComment": "/**\n * Get the stats of an augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns augmentation stats.\n *\n * @param name - Name of Augmentation. CASE-SENSITIVE.\n *\n * @returns Augmentation stats.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20535,7 +20677,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCharacterInformation:member(1)",
"docComment": "/**\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * Singularity - Level 1\n *\n * @deprecated\n *\n * Returns an object with various information about your character.\n *\n * @returns Object with various information about your character.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20564,7 +20706,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCompanyFavor:member(1)",
"docComment": "/**\n * Get company favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you have at the specified company.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20608,7 +20750,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCompanyFavorGain:member(1)",
"docComment": "/**\n * Get company favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20652,7 +20794,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCompanyRep:member(1)",
"docComment": "/**\n * Get company reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of reputation you have at the specified company.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20696,7 +20838,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCrimeChance:member(1)",
"docComment": "/**\n * Get chance to successfully commit a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns your chance of success at commiting the specified crime.\n *\n * @param crime - Name of crime.\n *\n * @returns Chance of success at commiting the specified crime.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20740,7 +20882,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCrimeStats:member(1)",
"docComment": "/**\n * Get stats related to a crime.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns the stats of the crime.\n *\n * @param crime - Name of crime. Not case-sensitive\n *\n * @returns The stats of the crime.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20785,7 +20927,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getCurrentServer:member(1)",
"docComment": "/**\n * Get the current server.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * @returns Name of the current server.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20813,7 +20955,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getFactionFavor:member(1)",
"docComment": "/**\n * Get faction favor.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of favor you have for the specified faction.\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you have for the specified faction.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20857,7 +20999,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getFactionFavorGain:member(1)",
"docComment": "/**\n * Get faction favor gain.\n *\n * @remarks\n *\n * RAM cost: 0.75 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20901,7 +21043,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getFactionRep:member(1)",
"docComment": "/**\n * Get faction reputation.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 2\n *\n * This function returns the amount of reputation you have for the specified faction.\n *\n * @param faction - Name of faction to work for.\n *\n * @returns Amount of reputation you have for the specified faction.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20945,7 +21087,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getOwnedAugmentations:member(1)",
"docComment": "/**\n * Get a list of owned augmentation.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function returns an array containing the names (as strings) of all Augmentations you have.\n *\n * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.\n *\n * @returns Array containing the names (as strings) of all Augmentations you have.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -20989,7 +21131,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getStats:member(1)",
"docComment": "/**\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * Singularity - Level 1\n *\n * @deprecated\n *\n * Returns an object with the Player’s stats.\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 * 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",
"excerptTokens": [
{
"kind": "Content",
@ -21018,7 +21160,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getUpgradeHomeCoresCost:member(1)",
"docComment": "/**\n * Get the price of upgrading home cores.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB\n *\n * Singularity - Level 2\n *\n * Returns the cost of upgrading the player’s home computer cores.\n *\n * @returns Cost of upgrading the player’s home computer cores.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21046,7 +21188,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getUpgradeHomeRamCost:member(1)",
"docComment": "/**\n * Get the price of upgrading home RAM.\n *\n * @remarks\n *\n * RAM cost: 1.5 GB\n *\n * Singularity - Level 2\n *\n * Returns the cost of upgrading the player’s home computer RAM.\n *\n * @returns Cost of upgrading the player’s home computer RAM.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21074,7 +21216,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#goToLocation:member(1)",
"docComment": "/**\n * Go to a location.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\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 * 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",
"excerptTokens": [
{
"kind": "Content",
@ -21118,7 +21260,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#gymWorkout:member(1)",
"docComment": "/**\n * Workout at the gym.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train\n *\n * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.\n *\n * @param stat - The stat you want to train.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21177,7 +21319,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#hospitalize:member(1)",
"docComment": "/**\n * Hospitalize the player.\n *\n * @remarks\n *\n * RAM cost: 0.25 GB\n *\n * Singularity - Level 1\n *\n * @returns The cost of the hospitalization.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21205,7 +21347,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#installAugmentations:member(1)",
"docComment": "/**\n * Install your purchased augmentations.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will automatically install your Augmentations, resetting the game as usual.\n *\n * @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21249,7 +21391,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#installBackdoor:member(1)",
"docComment": "/**\n * Run the backdoor command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * @returns True if the installation was successful.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21282,7 +21424,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#isBusy:member(1)",
"docComment": "/**\n * Check if the player is busy.\n *\n * @remarks\n *\n * RAM cost: 0.5 GB\n *\n * Singularity - Level 1\n *\n * Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.\n *\n * @returns True if the player is currently performing an ‘action’, false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21310,7 +21452,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#isFocused:member(1)",
"docComment": "/**\n * Check if the player is focused.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * Singularity - Level 2\n *\n * @returns True if the player is focused.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21338,7 +21480,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#joinFaction:member(1)",
"docComment": "/**\n * Join a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically accept an invitation from a faction and join it.\n *\n * @param faction - Name of faction to join.\n *\n * @returns True if player joined the faction, and false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21382,7 +21524,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#manualHack:member(1)",
"docComment": "/**\n * Run the hack command in the terminal.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * @returns Amount of money stolen by manual hacking.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21415,7 +21557,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#purchaseAugmentation:member(1)",
"docComment": "/**\n * Purchase an augmentation\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will try to purchase the specified Augmentation through the given Faction.\n *\n * This function will return true if the Augmentation is successfully purchased, and false otherwise.\n *\n * @param faction - Name of faction to purchase Augmentation from.\n *\n * @param augmentation - Name of Augmentation to purchase.\n *\n * @returns True if the Augmentation is successfully purchased, and false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21474,7 +21616,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#purchaseProgram:member(1)",
"docComment": "/**\n * Purchase a program from the dark web.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.\n *\n * @param programName - Name of program to purchase.\n *\n * @returns True if the specified program is purchased, and false otherwise.\n *\n * @example\n * ```ts\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n",
"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 * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -21518,7 +21660,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#purchaseTor:member(1)",
"docComment": "/**\n * Purchase the TOR router.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.\n *\n * @returns True if actions is successful, false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21546,7 +21688,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#setFocus:member(1)",
"docComment": "/**\n * Set the players focus.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n *\n * Singularity - Level 2\n */\n",
"docComment": "/**\n * SF4.2 - Set the players focus.\n *\n * @remarks\n *\n * RAM cost: 0.1 GB\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -21590,7 +21732,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#softReset:member(1)",
"docComment": "/**\n * Soft reset the game.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\n *\n * @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 * 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",
"excerptTokens": [
{
"kind": "Content",
@ -21634,7 +21776,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#stopAction:member(1)",
"docComment": "/**\n * Stop the current action.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Singularity - Level 1\n *\n * This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.\n *\n * The actions that can be stopped with this function are:\n *\n * * Studying at a university * Working for a company/faction * Creating a program * Committing a Crime\n *\n * This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called.\n *\n * @returns True if the player’s action was ended, false if the player was not performing an action.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21662,7 +21804,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#travelToCity:member(1)",
"docComment": "/**\n * Travel to another city.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency.\n *\n * @param city - City to travel to.\n *\n * @returns True if actions is successful, false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21706,7 +21848,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#universityCourse:member(1)",
"docComment": "/**\n * Take university class.\n *\n * @remarks\n *\n * RAM cost: 2 GB\n *\n * Singularity - Level 1\n *\n * This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.\n *\n * @param universityName - Name of university. You must be in the correct city for whatever university you specify.\n *\n * @param courseName - Name of course.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21765,7 +21907,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#upgradeHomeCores:member(1)",
"docComment": "/**\n * Upgrade home computer cores.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\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 * 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",
"excerptTokens": [
{
"kind": "Content",
@ -21793,7 +21935,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#upgradeHomeRam:member(1)",
"docComment": "/**\n * Upgrade home computer RAM.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.\n *\n * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.\n */\n",
"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",
"excerptTokens": [
{
"kind": "Content",
@ -21821,7 +21963,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#workForCompany:member(1)",
"docComment": "/**\n * Work for a company.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if the player starts working, and false otherwise.\n *\n * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action.\n *\n * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n",
"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 * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -21865,7 +22007,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#workForFaction:member(1)",
"docComment": "/**\n * Work for a faction.\n *\n * @remarks\n *\n * RAM cost: 3 GB\n *\n * Singularity - Level 2\n *\n * This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if you successfully start working for the specified faction, and false otherwise.\n *\n * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action.\n *\n * @param faction - Name of faction to work for.\n *\n * @param workType - Type of work to perform for the faction.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n",
"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 * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```ts\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",

4
main.bundle.js
View File

File diff suppressed because one or more lines are too long

2
main.bundle.js.map
View File

File diff suppressed because one or more lines are too long

11
markdown/bitburner.gangotherinfo._slum_snakes_.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; ["Slum Snakes"](./bitburner.gangotherinfo._slum_snakes_.md)
## GangOtherInfo."Slum Snakes" property
<b>Signature:</b>
```typescript
"Slum Snakes": GangOtherInfoObject;
```

11
markdown/bitburner.gangotherinfo._speakers_for_the_dead_.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; ["Speakers for the Dead"](./bitburner.gangotherinfo._speakers_for_the_dead_.md)
## GangOtherInfo."Speakers for the Dead" property
<b>Signature:</b>
```typescript
"Speakers for the Dead": GangOtherInfoObject;
```

11
markdown/bitburner.gangotherinfo._the_black_hand_.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; ["The Black Hand"](./bitburner.gangotherinfo._the_black_hand_.md)
## GangOtherInfo."The Black Hand" property
<b>Signature:</b>
```typescript
"The Black Hand": GangOtherInfoObject;
```

11
markdown/bitburner.gangotherinfo._the_dark_army_.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; ["The Dark Army"](./bitburner.gangotherinfo._the_dark_army_.md)
## GangOtherInfo."The Dark Army" property
<b>Signature:</b>
```typescript
"The Dark Army": GangOtherInfoObject;
```

11
markdown/bitburner.gangotherinfo._the_syndicate_.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; ["The Syndicate"](./bitburner.gangotherinfo._the_syndicate_.md)
## GangOtherInfo."The Syndicate" property
<b>Signature:</b>
```typescript
"The Syndicate": GangOtherInfoObject;
```

13
markdown/bitburner.gangotherinfo.md
View File

@ -10,3 +10,16 @@
```typescript
export interface GangOtherInfo
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| ["Slum Snakes"](./bitburner.gangotherinfo._slum_snakes_.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| ["Speakers for the Dead"](./bitburner.gangotherinfo._speakers_for_the_dead_.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| ["The Black Hand"](./bitburner.gangotherinfo._the_black_hand_.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| ["The Dark Army"](./bitburner.gangotherinfo._the_dark_army_.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| ["The Syndicate"](./bitburner.gangotherinfo._the_syndicate_.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| [NiteSec](./bitburner.gangotherinfo.nitesec.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| [Tetrads](./bitburner.gangotherinfo.tetrads.md) | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |

11
markdown/bitburner.gangotherinfo.nitesec.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; [NiteSec](./bitburner.gangotherinfo.nitesec.md)
## GangOtherInfo.NiteSec property
<b>Signature:</b>
```typescript
NiteSec: GangOtherInfoObject;
```

11
markdown/bitburner.gangotherinfo.tetrads.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md) &gt; [Tetrads](./bitburner.gangotherinfo.tetrads.md)
## GangOtherInfo.Tetrads property
<b>Signature:</b>
```typescript
Tetrads: GangOtherInfoObject;
```

2
markdown/bitburner.ns.getserverbasesecuritylevel.md
View File

@ -6,7 +6,7 @@
> Warning: This API is now obsolete.
>
> DEPRECATED
> useless
>
<b>Signature:</b>

2
markdown/bitburner.ns.getserverram.md
View File

@ -6,7 +6,7 @@
> Warning: This API is now obsolete.
>
> DEPRECATED
> use getServerMaxRam / getServerUsedRam
>
<b>Signature:</b>

4
markdown/bitburner.singularity.applytocompany.md
View File

@ -4,7 +4,7 @@
## Singularity.applyToCompany() method
Apply for a job at a company.
SF4.2 - Apply for a job at a company.
<b>Signature:</b>
@ -29,8 +29,6 @@ True if the player successfully get a job/promotion, and false otherwise.
RAM cost: 3 GB
Singularity - Level 2
This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.
This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.

4
markdown/bitburner.singularity.checkfactioninvitations.md
View File

@ -4,7 +4,7 @@
## Singularity.checkFactionInvitations() method
List all current faction invitations.
SF4.2 - List all current faction invitations.
<b>Signature:</b>
@ -21,7 +21,5 @@ Array with the name of all Factions you currently have oustanding invitations fr
RAM cost: 3 GB
Singularity - Level 2
Returns an array with the name of all Factions you currently have oustanding invitations from.

4
markdown/bitburner.singularity.commitcrime.md
View File

@ -4,7 +4,7 @@
## Singularity.commitCrime() method
Commit a crime.
SF4.3 - Commit a crime.
<b>Signature:</b>
@ -28,8 +28,6 @@ True if you successfully start working on the specified program, and false other
RAM cost: 5 GB
Singularity - Level 3
This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.
This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60).

4
markdown/bitburner.singularity.connect.md
View File

@ -4,7 +4,7 @@
## Singularity.connect() method
Connect to a server.
SF4.1 - Connect to a server.
<b>Signature:</b>
@ -28,7 +28,5 @@ True if the connect command was successful, false otherwise.
RAM cost: 2 GB
Singularity - Level 1
Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.

4
markdown/bitburner.singularity.createprogram.md
View File

@ -4,7 +4,7 @@
## Singularity.createProgram() method
Create a program.
SF4.3 - Create a program.
<b>Signature:</b>
@ -28,8 +28,6 @@ True if you successfully start working on the specified program, and false other
RAM cost: 5 GB
Singularity - Level 3
This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.
This function returns true if you successfully start working on the specified program, and false otherwise.

4
markdown/bitburner.singularity.donatetofaction.md
View File

@ -4,7 +4,7 @@
## Singularity.donateToFaction() method
Donate to a faction.
SF4.3 - Donate to a faction.
<b>Signature:</b>
@ -29,7 +29,5 @@ True if the money was donated, and false otherwise.
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.

6
markdown/bitburner.singularity.getaugmentationcost.md
View File

@ -6,9 +6,11 @@
> Warning: This API is now obsolete.
>
> Get the price and reputation of an augmentation.
> use getAugmentationPrice getAugmentationRepCost
>
SF4.3 - Get the price and reputation of an augmentation.
<b>Signature:</b>
```typescript
@ -31,8 +33,6 @@ Array with first element as a reputation requirement and second element as the m
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 reputation requirement of the Augmentation, and the second element is the money cost.
If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\].

4
markdown/bitburner.singularity.getaugmentationprereq.md
View File

@ -4,7 +4,7 @@
## Singularity.getAugmentationPrereq() method
Get the pre-requisite of an augmentation.
SF4.3 - Get the pre-requisite of an augmentation.
<b>Signature:</b>
@ -28,7 +28,5 @@ Array with the names of the prerequisite Augmentation(s) for the specified Augme
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.

4
markdown/bitburner.singularity.getaugmentationprice.md
View File

@ -4,7 +4,7 @@
## Singularity.getAugmentationPrice() method
Get price of an augmentation.
SF4.3 - Get price of an augmentation.
<b>Signature:</b>
@ -28,5 +28,3 @@ Price of the augmentation.
RAM cost: 2.5 GB
Singularity - Level 3

4
markdown/bitburner.singularity.getaugmentationrepreq.md
View File

@ -4,7 +4,7 @@
## Singularity.getAugmentationRepReq() method
Get reputation requirement of an augmentation.
SF4.3 - Get reputation requirement of an augmentation.
<b>Signature:</b>
@ -28,5 +28,3 @@ Reputation requirement of the augmentation.
RAM cost: 2.5 GB
Singularity - Level 3

4
markdown/bitburner.singularity.getaugmentationsfromfaction.md
View File

@ -4,7 +4,7 @@
## Singularity.getAugmentationsFromFaction() method
Get a list of augmentation available from a faction.
SF4.3 - Get a list of augmentation available from a faction.
<b>Signature:</b>
@ -28,7 +28,5 @@ Array containing the names of all Augmentations.
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.

4
markdown/bitburner.singularity.getaugmentationstats.md
View File

@ -4,7 +4,7 @@
## Singularity.getAugmentationStats() method
Get the stats of an augmentation.
SF4.3 - Get the stats of an augmentation.
<b>Signature:</b>
@ -28,7 +28,5 @@ Augmentation stats.
RAM cost: 5 GB
Singularity - Level 3
This function returns augmentation stats.

6
markdown/bitburner.singularity.getcharacterinformation.md
View File

@ -6,9 +6,11 @@
> Warning: This API is now obsolete.
>
> Returns an object with various information about your character.
> use getPlayer
>
SF4.1 - Returns an object with various information about your character.
<b>Signature:</b>
```typescript
@ -24,5 +26,3 @@ Object with various information about your character.
RAM cost: 0.5 GB
Singularity - Level 1

4
markdown/bitburner.singularity.getcompanyfavor.md
View File

@ -4,7 +4,7 @@
## Singularity.getCompanyFavor() method
Get company favor.
SF4.2 - Get company favor.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of favor you have at the specified company.
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.

4
markdown/bitburner.singularity.getcompanyfavorgain.md
View File

@ -4,7 +4,7 @@
## Singularity.getCompanyFavorGain() method
Get company favor gain.
SF4.2 - Get company favor gain.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of favor you gain at the specified company when you reset by installing A
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.

4
markdown/bitburner.singularity.getcompanyrep.md
View File

@ -4,7 +4,7 @@
## Singularity.getCompanyRep() method
Get company reputation.
SF4.2 - Get company reputation.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of reputation you have at the specified company.
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.

4
markdown/bitburner.singularity.getcrimechance.md
View File

@ -4,7 +4,7 @@
## Singularity.getCrimeChance() method
Get chance to successfully commit a crime.
SF4.3 - Get chance to successfully commit a crime.
<b>Signature:</b>
@ -28,7 +28,5 @@ Chance of success at commiting the specified crime.
RAM cost: 5 GB
Singularity - Level 3
This function returns your chance of success at commiting the specified crime.

4
markdown/bitburner.singularity.getcrimestats.md
View File

@ -4,7 +4,7 @@
## Singularity.getCrimeStats() method
Get stats related to a crime.
SF4.3 - Get stats related to a crime.
<b>Signature:</b>
@ -28,7 +28,5 @@ The stats of the crime.
RAM cost: 5 GB
Singularity - Level 3
Returns the stats of the crime.

4
markdown/bitburner.singularity.getcurrentserver.md
View File

@ -4,7 +4,7 @@
## Singularity.getCurrentServer() method
Get the current server.
SF4.1 - Get the current server.
<b>Signature:</b>
@ -21,5 +21,3 @@ Name of the current server.
RAM cost: 2 GB
Singularity - Level 1

4
markdown/bitburner.singularity.getfactionfavor.md
View File

@ -4,7 +4,7 @@
## Singularity.getFactionFavor() method
Get faction favor.
SF4.2 - Get faction favor.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of favor you have for the specified faction.
RAM cost: 1 GB
Singularity - Level 2
This function returns the amount of favor you have for the specified faction.

4
markdown/bitburner.singularity.getfactionfavorgain.md
View File

@ -4,7 +4,7 @@
## Singularity.getFactionFavorGain() method
Get faction favor gain.
SF4.2 - Get faction favor gain.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of favor you will gain for the specified faction when you reset by instal
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.

4
markdown/bitburner.singularity.getfactionrep.md
View File

@ -4,7 +4,7 @@
## Singularity.getFactionRep() method
Get faction reputation.
SF4.2 - Get faction reputation.
<b>Signature:</b>
@ -28,7 +28,5 @@ Amount of reputation you have for the specified faction.
RAM cost: 1 GB
Singularity - Level 2
This function returns the amount of reputation you have for the specified faction.

4
markdown/bitburner.singularity.getownedaugmentations.md
View File

@ -4,7 +4,7 @@
## Singularity.getOwnedAugmentations() method
Get a list of owned augmentation.
SF4.3 - Get a list of owned augmentation.
<b>Signature:</b>
@ -28,7 +28,5 @@ Array containing the names (as strings) of all Augmentations you have.
RAM cost: 5 GB
Singularity - Level 3
This function returns an array containing the names (as strings) of all Augmentations you have.

6
markdown/bitburner.singularity.getstats.md
View File

@ -6,9 +6,11 @@
> Warning: This API is now obsolete.
>
> Returns an object with the Player’s stats.
> use getPlayer
>
SF4.1 - Returns an object with the Player’s stats.
<b>Signature:</b>
```typescript
@ -24,8 +26,6 @@ Object with the Player’s stats.
RAM cost: 0.5 GB
Singularity - Level 1
## Example

4
markdown/bitburner.singularity.getupgradehomecorescost.md
View File

@ -4,7 +4,7 @@
## Singularity.getUpgradeHomeCoresCost() method
Get the price of upgrading home cores.
SF4.2 - Get the price of upgrading home cores.
<b>Signature:</b>
@ -21,7 +21,5 @@ Cost of upgrading the player’s home computer cores.
RAM cost: 1.5 GB
Singularity - Level 2
Returns the cost of upgrading the player’s home computer cores.

4
markdown/bitburner.singularity.getupgradehomeramcost.md
View File

@ -4,7 +4,7 @@
## Singularity.getUpgradeHomeRamCost() method
Get the price of upgrading home RAM.
SF4.2 - Get the price of upgrading home RAM.
<b>Signature:</b>
@ -21,7 +21,5 @@ Cost of upgrading the player’s home computer RAM.
RAM cost: 1.5 GB
Singularity - Level 2
Returns the cost of upgrading the player’s home computer RAM.

4
markdown/bitburner.singularity.gotolocation.md
View File

@ -4,7 +4,7 @@
## Singularity.goToLocation() method
Go to a location.
SF4.3 - Go to a location.
<b>Signature:</b>
@ -28,7 +28,5 @@ True if the player was moved there, false otherwise.
RAM cost: 5 GB
Singularity - Level 3
Move the player to a specific location.

4
markdown/bitburner.singularity.gymworkout.md
View File

@ -4,7 +4,7 @@
## Singularity.gymWorkout() method
Workout at the gym.
SF4.1 - Workout at the gym.
<b>Signature:</b>
@ -29,8 +29,6 @@ True if actions is successfully started, false otherwise.
RAM cost: 2 GB
Singularity - Level 1
This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.
The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train

4
markdown/bitburner.singularity.hospitalize.md
View File

@ -4,7 +4,7 @@
## Singularity.hospitalize() method
Hospitalize the player.
SF4.1 - Hospitalize the player.
<b>Signature:</b>
@ -21,5 +21,3 @@ The cost of the hospitalization.
RAM cost: 0.25 GB
Singularity - Level 1

4
markdown/bitburner.singularity.installaugmentations.md
View File

@ -4,7 +4,7 @@
## Singularity.installAugmentations() method
Install your purchased augmentations.
SF4.3 - Install your purchased augmentations.
<b>Signature:</b>
@ -26,7 +26,5 @@ void
RAM cost: 5 GB
Singularity - Level 3
This function will automatically install your Augmentations, resetting the game as usual.

4
markdown/bitburner.singularity.installbackdoor.md
View File

@ -4,7 +4,7 @@
## Singularity.installBackdoor() method
Run the backdoor command in the terminal.
SF4.1 - Run the backdoor command in the terminal.
<b>Signature:</b>
@ -21,5 +21,3 @@ True if the installation was successful.
RAM cost: 2 GB
Singularity - Level 1

4
markdown/bitburner.singularity.isbusy.md
View File

@ -4,7 +4,7 @@
## Singularity.isBusy() method
Check if the player is busy.
SF4.1 - Check if the player is busy.
<b>Signature:</b>
@ -21,7 +21,5 @@ True if the player is currently performing an ‘action’, false otherwise.
RAM cost: 0.5 GB
Singularity - Level 1
Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.

4
markdown/bitburner.singularity.isfocused.md
View File

@ -4,7 +4,7 @@
## Singularity.isFocused() method
Check if the player is focused.
SF4.2 - Check if the player is focused.
<b>Signature:</b>
@ -21,5 +21,3 @@ True if the player is focused.
RAM cost: 0.1 GB
Singularity - Level 2

4
markdown/bitburner.singularity.joinfaction.md
View File

@ -4,7 +4,7 @@
## Singularity.joinFaction() method
Join a faction.
SF4.2 - Join a faction.
<b>Signature:</b>
@ -28,7 +28,5 @@ True if player joined the faction, and false otherwise.
RAM cost: 3 GB
Singularity - Level 2
This function will automatically accept an invitation from a faction and join it.

4
markdown/bitburner.singularity.manualhack.md
View File

@ -4,7 +4,7 @@
## Singularity.manualHack() method
Run the hack command in the terminal.
SF4.1 - Run the hack command in the terminal.
<b>Signature:</b>
@ -21,5 +21,3 @@ Amount of money stolen by manual hacking.
RAM cost: 2 GB
Singularity - Level 1

94
markdown/bitburner.singularity.md
View File

@ -20,51 +20,51 @@ This API requires Source-File 4 level 1 / 2 / 3 to use.
| Method | Description |
| --- | --- |
| [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)](./bitburner.singularity.createprogram.md) | Create a program. |
| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. |
| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | |
| [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) | |
| [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) | |
| [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)](./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)](./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)](./bitburner.singularity.workforcompany.md) | Work for a company. |
| [workForFaction(faction, workType)](./bitburner.singularity.workforfaction.md) | Work for a faction. |
| [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)](./bitburner.singularity.workforcompany.md) | SF4.2 - Work for a company. |
| [workForFaction(faction, workType)](./bitburner.singularity.workforfaction.md) | SF4.2 - Work for a faction. |

4
markdown/bitburner.singularity.purchaseaugmentation.md
View File

@ -4,7 +4,7 @@
## Singularity.purchaseAugmentation() method
Purchase an augmentation
SF4.3 - Purchase an augmentation
<b>Signature:</b>
@ -29,8 +29,6 @@ True if the Augmentation is successfully purchased, and false otherwise.
RAM cost: 5 GB
Singularity - Level 3
This function will try to purchase the specified Augmentation through the given Faction.
This function will return true if the Augmentation is successfully purchased, and false otherwise.

4
markdown/bitburner.singularity.purchaseprogram.md
View File

@ -4,7 +4,7 @@
## Singularity.purchaseProgram() method
Purchase a program from the dark web.
SF4.1 - Purchase a program from the dark web.
<b>Signature:</b>
@ -28,8 +28,6 @@ True if the specified program is purchased, and false otherwise.
RAM cost: 2 GB
Singularity - Level 1
This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.
## Example

4
markdown/bitburner.singularity.purchasetor.md
View File

@ -4,7 +4,7 @@
## Singularity.purchaseTor() method
Purchase the TOR router.
SF4.1 - Purchase the TOR router.
<b>Signature:</b>
@ -21,7 +21,5 @@ True if actions is successful, false otherwise.
RAM cost: 2 GB
Singularity - Level 1
This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.

4
markdown/bitburner.singularity.setfocus.md
View File

@ -4,7 +4,7 @@
## Singularity.setFocus() method
Set the players focus.
SF4.2 - Set the players focus.
<b>Signature:</b>
@ -26,5 +26,3 @@ void
RAM cost: 0.1 GB
Singularity - Level 2

4
markdown/bitburner.singularity.softreset.md
View File

@ -4,7 +4,7 @@
## Singularity.softReset() method
Soft reset the game.
SF4.3 - Soft reset the game.
<b>Signature:</b>
@ -26,7 +26,5 @@ void
RAM cost: 5 GB
Singularity - Level 3
This function will perform a reset even if you don’t have any augmentation installed.

4
markdown/bitburner.singularity.stopaction.md
View File

@ -4,7 +4,7 @@
## Singularity.stopAction() method
Stop the current action.
SF4.1 - Stop the current action.
<b>Signature:</b>
@ -21,8 +21,6 @@ True if the player’s action was ended, false if the player was not performing
RAM cost: 1 GB
Singularity - Level 1
This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.
The actions that can be stopped with this function are:

4
markdown/bitburner.singularity.traveltocity.md
View File

@ -4,7 +4,7 @@
## Singularity.travelToCity() method
Travel to another city.
SF4.1 - Travel to another city.
<b>Signature:</b>
@ -28,7 +28,5 @@ True if actions is successful, false otherwise.
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.

4
markdown/bitburner.singularity.universitycourse.md
View File

@ -4,7 +4,7 @@
## Singularity.universityCourse() method
Take university class.
SF4.1 - Take university class.
<b>Signature:</b>
@ -29,8 +29,6 @@ True if actions is successfully started, false otherwise.
RAM cost: 2 GB
Singularity - Level 1
This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.
The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.

4
markdown/bitburner.singularity.upgradehomecores.md
View File

@ -4,7 +4,7 @@
## Singularity.upgradeHomeCores() method
Upgrade home computer cores.
SF4.2 - Upgrade home computer cores.
<b>Signature:</b>
@ -21,8 +21,6 @@ True if the player’s home computer cores is successfully upgraded, and false o
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.
This function will return true if the player’s home computer cores is successfully upgraded, and false otherwise.

4
markdown/bitburner.singularity.upgradehomeram.md
View File

@ -4,7 +4,7 @@
## Singularity.upgradeHomeRam() method
Upgrade home computer RAM.
SF4.2 - Upgrade home computer RAM.
<b>Signature:</b>
@ -21,8 +21,6 @@ True if the player’s home computer RAM is successfully upgraded, and false oth
RAM cost: 3 GB
Singularity - Level 2
This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.
This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.

4
markdown/bitburner.singularity.workforcompany.md
View File

@ -4,7 +4,7 @@
## Singularity.workForCompany() method
Work for a company.
SF4.2 - Work for a company.
<b>Signature:</b>
@ -28,8 +28,6 @@ True if the player starts working, and false otherwise.
RAM cost: 3 GB
Singularity - Level 2
This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.
This function will return true if the player starts working, and false otherwise.

4
markdown/bitburner.singularity.workforfaction.md
View File

@ -4,7 +4,7 @@
## Singularity.workForFaction() method
Work for a faction.
SF4.2 - Work for a faction.
<b>Signature:</b>
@ -29,8 +29,6 @@ True if the player starts working, and false otherwise.
RAM cost: 3 GB
Singularity - Level 2
This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.
This function will return true if you successfully start working for the specified faction, and false otherwise.

4
src/Gang/Gang.ts
View File

@ -224,7 +224,9 @@ export class Gang {
if (AllGangs[otherGang].territory <= 0) return;
const territoryGain = calculateTerritoryGain(thisGang, otherGang);
AllGangs[thisGang].territory += territoryGain;
if (AllGangs[thisGang].territory > 1) AllGangs[thisGang].territory = 1;
AllGangs[otherGang].territory -= territoryGain;
if (AllGangs[thisGang].territory < 0) AllGangs[thisGang].territory = 0;
if (thisGang === gangName) {
this.clash(true); // Player won
AllGangs[otherGang].power *= 1 / 1.01;
@ -237,7 +239,9 @@ export class Gang {
if (AllGangs[thisGang].territory <= 0) return;
const territoryGain = calculateTerritoryGain(otherGang, thisGang);
AllGangs[thisGang].territory -= territoryGain;
if (AllGangs[otherGang].territory < 0) AllGangs[otherGang].territory = 0;
AllGangs[otherGang].territory += territoryGain;
if (AllGangs[otherGang].territory > 1) AllGangs[otherGang].territory = 1;
if (thisGang === gangName) {
this.clash(false); // Player lost
} else if (otherGang === gangName) {

4
src/NetscriptFunctions/Singularity.ts
View File

@ -114,6 +114,8 @@ export function NetscriptSingularity(
if (player.hasGangWith(facname)) {
const res = [];
for (const augName in Augmentations) {
if (augName === AugmentationNames.NeuroFluxGovernor) continue;
if (augName === AugmentationNames.TheRedPill && player.bitNodeN !== 2) continue;
const aug = Augmentations[augName];
if (!aug.isSpecial) {
res.push(augName);
@ -953,7 +955,7 @@ export function NetscriptSingularity(
// if the player is in a gang and the target faction is any of the gang faction, fail
if (player.inGang() && AllGangs[name] !== undefined) {
workerScript.log("workForFaction", () => `Faction '${name}' does not offer work at the moment.`);
return;
return false;
}
if (!player.factions.includes(name)) {

162
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,11 +1725,10 @@ export interface Singularity {
getOwnedAugmentations(purchased?: boolean): string[];
/**
* Get a list of augmentation available from a faction.
* SF4.3 - 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.
@ -1763,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.
@ -1778,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
@ -1799,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.
@ -1811,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.
@ -1823,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.
*
@ -1840,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.
*
@ -1854,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.
*
@ -1867,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
@ -1885,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.
*
@ -1922,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.
*
@ -1936,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.
*
@ -1960,44 +1922,40 @@ 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>;
/**
* Check if the player is focused.
* SF4.2 - Check if the player is focused.
* @remarks
* RAM cost: 0.1 GB
*
* Singularity - Level 2
*
* @returns True if the player is focused.
*/
isFocused(): void;
/**
* Set the players focus.
* SF4.2 - Set the players focus.
* @remarks
* RAM cost: 0.1 GB
*
* Singularity - Level 2
*/
setFocus(focus: boolean): void;
}
@ -4273,8 +4231,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
@ -4291,8 +4248,7 @@ export interface NS extends Singularity {
getServerBaseSecurityLevel(host: string): number;
/**
* @deprecated
* DEPRECATED
* @deprecated use getServerMaxRam / getServerUsedRam
* @remarks
* RAM cost: 0.1 GB
*

1
src/ui/React/LogBoxManager.tsx
View File

@ -110,6 +110,7 @@ function LogWindow(props: IProps): React.ReactElement {
}
useEffect(() => {
updateLayer();
const id = setInterval(rerender, 1000);
return () => clearInterval(id);
}, []);