2021-10-30 18:34:14 +02:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home ](./index.md ) > [bitburner ](./bitburner.md ) > [Singularity ](./bitburner.singularity.md )
## Singularity interface
2021-10-30 21:46:34 +02:00
Singularity API
2021-10-30 18:34:14 +02:00
< b > Signature:< / b >
```typescript
2021-11-03 23:16:10 +01:00
export interface Singularity
2021-10-30 18:34:14 +02:00
```
2021-11-03 05:27:21 +01:00
## Remarks
This API requires Source-File 4 level 1 / 2 / 3 to use.
2021-10-30 18:34:14 +02:00
## Methods
| Method | Description |
| --- | --- |
2021-11-03 05:27:21 +01:00
| [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. |
2021-11-04 01:19:52 +01:00
| [connect(hostname) ](./bitburner.singularity.connect.md ) | Connect to a server. |
2021-11-03 05:27:21 +01:00
| [createProgram(program) ](./bitburner.singularity.createprogram.md ) | Create a program. |
| [donateToFaction(faction, amount) ](./bitburner.singularity.donatetofaction.md ) | Donate to a faction. |
2021-11-04 01:19:52 +01:00
| [getAugmentationCost(augName) ](./bitburner.singularity.getaugmentationcost.md ) | |
2021-11-03 05:27:21 +01:00
| [getAugmentationPrereq(augName) ](./bitburner.singularity.getaugmentationprereq.md ) | Get the pre-requisite of an augmentation. |
2021-11-04 01:19:52 +01:00
| [getAugmentationPrice(augName) ](./bitburner.singularity.getaugmentationprice.md ) | Get price of an augmentation. |
| [getAugmentationRepReq(augName) ](./bitburner.singularity.getaugmentationrepreq.md ) | Get reputation requirement of an augmentation. |
2021-11-03 05:27:21 +01:00
| [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. |
2021-11-04 01:19:52 +01:00
| [getCharacterInformation() ](./bitburner.singularity.getcharacterinformation.md ) | |
2021-11-03 05:27:21 +01:00
| [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. |
2021-11-04 01:19:52 +01:00
| [getCurrentServer() ](./bitburner.singularity.getcurrentserver.md ) | Get the current server. |
2021-11-03 05:27:21 +01:00
| [getFactionFavor(faction) ](./bitburner.singularity.getfactionfavor.md ) | Get faction favor. |
| [getFactionFavorGain(faction) ](./bitburner.singularity.getfactionfavorgain.md ) | Get faction favor gain. |
| [getFactionRep(faction) ](./bitburner.singularity.getfactionrep.md ) | Get faction reputation. |
| [getOwnedAugmentations(purchased) ](./bitburner.singularity.getownedaugmentations.md ) | Get a list of owned augmentation. |
| [getOwnedSourceFiles() ](./bitburner.singularity.getownedsourcefiles.md ) | Get a list of acquired Source-Files. |
2021-11-04 01:19:52 +01:00
| [getStats() ](./bitburner.singularity.getstats.md ) | |
| [getUpgradeHomeCoresCost() ](./bitburner.singularity.getupgradehomecorescost.md ) | Get the price of upgrading home cores. |
2021-11-03 05:27:21 +01:00
| [getUpgradeHomeRamCost() ](./bitburner.singularity.getupgradehomeramcost.md ) | Get the price of upgrading home RAM. |
2021-11-04 01:19:52 +01:00
| [goToLocation(locationName) ](./bitburner.singularity.gotolocation.md ) | Go to a location. |
2021-11-03 05:27:21 +01:00
| [gymWorkout(gymName, stat) ](./bitburner.singularity.gymworkout.md ) | Workout at the gym. |
2021-11-04 01:19:52 +01:00
| [hospitalize() ](./bitburner.singularity.hospitalize.md ) | Hospitalize the player. |
2021-11-03 05:27:21 +01:00
| [installAugmentations(cbScript) ](./bitburner.singularity.installaugmentations.md ) | Install your purchased augmentations. |
2021-11-04 01:19:52 +01:00
| [installBackdoor() ](./bitburner.singularity.installbackdoor.md ) | Run the backdoor command in the terminal. |
2021-11-03 05:27:21 +01:00
| [isBusy() ](./bitburner.singularity.isbusy.md ) | Check if the player is busy. |
| [joinFaction(faction) ](./bitburner.singularity.joinfaction.md ) | Join a faction. |
2021-11-04 01:19:52 +01:00
| [manualHack() ](./bitburner.singularity.manualhack.md ) | Run the hack command in the terminal. |
2021-11-03 05:27:21 +01:00
| [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. |
2021-11-04 01:19:52 +01:00
| [softReset(cbScript) ](./bitburner.singularity.softreset.md ) | Soft reset the game. |
2021-11-03 05:27:21 +01:00
| [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. |
2021-11-04 01:19:52 +01:00
| [upgradeHomeCores() ](./bitburner.singularity.upgradehomecores.md ) | Upgrade home computer cores. |
2021-11-03 05:27:21 +01:00
| [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. |
2021-10-30 18:34:14 +02:00