bitburner-src/markdown/bitburner.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [bitburner](./bitburner.md)

## bitburner package

## Enumerations

|  Enumeration | Description |
|  --- | --- |
|  [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Action types of Bladeburner |
|  [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Black Operation names of Bladeburner |
|  [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | Contract names of Bladeburner |
|  [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | General action names of Bladeburner |
|  [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | Operation names of Bladeburner |
|  [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill names type of Bladeburner |
|  [CityName](./bitburner.cityname.md) | Names of all cities |
|  [CompanyName](./bitburner.companyname.md) | Names of all companies |
|  [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) |  |
|  [CrimeType](./bitburner.crimetype.md) |  |
|  [FactionWorkType](./bitburner.factionworktype.md) |  |
|  [GymLocationName](./bitburner.gymlocationname.md) | Locations of gym |
|  [GymType](./bitburner.gymtype.md) |  |
|  [JobField](./bitburner.jobfield.md) |  |
|  [JobName](./bitburner.jobname.md) |  |
|  [LocationName](./bitburner.locationname.md) | Names of all locations |
|  [OrderType](./bitburner.ordertype.md) |  |
|  [PositionType](./bitburner.positiontype.md) |  |
|  [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | These special Bladeburner action types are only for Sleeve |
|  [ToastVariant](./bitburner.toastvariant.md) |  |
|  [UniversityClassType](./bitburner.universityclasstype.md) |  |
|  [UniversityLocationName](./bitburner.universitylocationname.md) | Locations of university |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [ActiveFragment](./bitburner.activefragment.md) |  |
|  [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) |
|  [AutocompleteData](./bitburner.autocompletedata.md) | Used for autocompletion |
|  [BackdoorRequirement](./bitburner.backdoorrequirement.md) | Player must have installed a backdoor on this server. |
|  [BaseTask](./bitburner.basetask.md) | Base interface of all tasks. |
|  [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow](./bitburner.ns.grow.md)<!-- -->, and [weaken](./bitburner.ns.weaken.md)<!-- -->. |
|  [BitNodeBooleanOptions](./bitburner.bitnodebooleanoptions.md) | <p>restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1.</p><p>disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them.</p> |
|  [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. |
|  [BitNodeOptions](./bitburner.bitnodeoptions.md) | <p>Default value: - sourceFileOverrides: an empty Map - intelligenceOverride: undefined - All boolean options: false</p><p>If you specify intelligenceOverride, it must be a non-negative integer.</p> |
|  [BitNodeRequirement](./bitburner.bitnoderequirement.md) | Player must be located in this BitNode. |
|  [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API |
|  [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. |
|  [BladeburnerFormulas](./bitburner.bladeburnerformulas.md) | Bladeburner formulas |
|  [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) | Player must have at least this rank in the Bladeburner Division. |
|  [CityRequirement](./bitburner.cityrequirement.md) | Player must be located in this city. |
|  [CodingContract](./bitburner.codingcontract.md) | Coding Contract API |
|  [CompanyPositionInfo](./bitburner.companypositioninfo.md) | Company position requirements and salary. |
|  [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) | Player must have at least this much reputation with this company. |
|  [CompanyWorkTask](./bitburner.companyworktask.md) | Company Work |
|  [CorpConstants](./bitburner.corpconstants.md) | Corporation related constants |
|  [CorpIndustryData](./bitburner.corpindustrydata.md) | Data for an individual industry |
|  [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) | Corporation material information |
|  [Corporation](./bitburner.corporation.md) | Corporation API |
|  [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation |
|  [CorpProductData](./bitburner.corpproductdata.md) | Product rating information |
|  [CreateProgramWorkTask](./bitburner.createprogramworktask.md) | Create Program |
|  [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
|  [CrimeTask](./bitburner.crimetask.md) | Crime |
|  [Division](./bitburner.division.md) | Corporation division |
|  [EmployedByRequirement](./bitburner.employedbyrequirement.md) | Player must be working for this company. |
|  [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
|  [EveryRequirement](./bitburner.everyrequirement.md) | All sub-conditions must be satisfied. |
|  [Export](./bitburner.export.md) | Export order for a material |
|  [FactionWorkTask](./bitburner.factionworktask.md) | Faction Work |
|  [FileRequirement](./bitburner.filerequirement.md) | Player must have a specific Literature or Message file on their home computer. |
|  [Formulas](./bitburner.formulas.md) | Formulas API |
|  [Fragment](./bitburner.fragment.md) |  |
|  [GameInfo](./bitburner.gameinfo.md) | Game Information |
|  [Gang](./bitburner.gang.md) | Gang API |
|  [GangFormulas](./bitburner.gangformulas.md) | Gang formulas |
|  [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
|  [GangMemberAscension](./bitburner.gangmemberascension.md) |  |
|  [GangMemberInfo](./bitburner.gangmemberinfo.md) |  |
|  [GangMemberInstall](./bitburner.gangmemberinstall.md) |  |
|  [GangOtherInfo](./bitburner.gangotherinfo.md) |  |
|  [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) |  |
|  [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
|  [GangTerritory](./bitburner.gangterritory.md) |  |
|  [Go](./bitburner.go.md) | IPvGO api |
|  [GoAnalysis](./bitburner.goanalysis.md) | Tools to analyze the IPvGO subnet. |
|  [GoCheat](./bitburner.gocheat.md) | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. |
|  [Grafting](./bitburner.grafting.md) | Grafting API |
|  [GraftingTask](./bitburner.graftingtask.md) | Grafting Work |
|  [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
|  [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
|  [Hacknet](./bitburner.hacknet.md) | Hacknet API |
|  [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) | Player's Hacknet devices must have at least this many total cores. |
|  [HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md) | Player's Hacknet devices must have at least this many total levels. |
|  [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
|  [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants |
|  [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
|  [HacknetRAMRequirement](./bitburner.hacknetramrequirement.md) | Player's Hacknet devices must have at least this much total RAM. |
|  [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
|  [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
|  [HP](./bitburner.hp.md) |  |
|  [ILocation](./bitburner.ilocation.md) |  |
|  [IndustryData](./bitburner.industrydata.md) | Corporation industry information |
|  [Infiltration](./bitburner.infiltration.md) | Infiltration API. |
|  [InfiltrationLocation](./bitburner.infiltrationlocation.md) |  |
|  [InfiltrationReward](./bitburner.infiltrationreward.md) |  |
|  [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
|  [IStyleSettings](./bitburner.istylesettings.md) | Interface Styles |
|  [JobTitleRequirement](./bitburner.jobtitlerequirement.md) | Player must have this job title at some company. |
|  [KarmaRequirement](./bitburner.karmarequirement.md) | Player must have less than this much karma. |
|  [LocationRequirement](./bitburner.locationrequirement.md) | Player must be at this location within a city. |
|  [Material](./bitburner.material.md) | Material in a warehouse |
|  [MoneyRequirement](./bitburner.moneyrequirement.md) | Player must have at least this much money. |
|  [MoneySource](./bitburner.moneysource.md) |  |
|  [MoneySources](./bitburner.moneysources.md) |  |
|  [Multipliers](./bitburner.multipliers.md) |  |
|  [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. |
|  [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. |
|  [NotRequirement](./bitburner.notrequirement.md) | The sub-condition must not be satisfied. |
|  [NS](./bitburner.ns.md) | Collection of all functions passed to scripts |
|  [NumAugmentationsRequirement](./bitburner.numaugmentationsrequirement.md) | Player must have at least this many augmentations installed (if positive). Player must have no augmentations installed (if zero). |
|  [NumInfiltrationsRequirement](./bitburner.numinfiltrationsrequirement.md) | Player must have completed this many infiltrations. |
|  [Office](./bitburner.office.md) | Office for a division in a city. |
|  [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API |
|  [PeopleKilledRequirement](./bitburner.peoplekilledrequirement.md) | Player must have killed at least this many people. |
|  [Person](./bitburner.person.md) |  |
|  [Player](./bitburner.player.md) |  |
|  [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. |
|  [Product](./bitburner.product.md) | Product in a warehouse |
|  [ReactElement](./bitburner.reactelement.md) | A stand-in for the real React.ReactElement. Use React.createElement to make these. See [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation. |
|  [RecentScript](./bitburner.recentscript.md) |  |
|  [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas |
|  [ResetInfo](./bitburner.resetinfo.md) | Various info about resets |
|  [RunningScript](./bitburner.runningscript.md) |  |
|  [RunOptions](./bitburner.runoptions.md) |  |
|  [Server](./bitburner.server.md) | A server. Not all servers have all of these properties - optional properties are missing on certain servers. |
|  [Singularity](./bitburner.singularity.md) | Singularity API |
|  [SkillRequirement](./bitburner.skillrequirement.md) | Player must have each listed skill at least this level. |
|  [Skills](./bitburner.skills.md) |  |
|  [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
|  [Sleeve](./bitburner.sleeve.md) | Sleeve API |
|  [SleevePerson](./bitburner.sleeveperson.md) |  |
|  [SomeRequirement](./bitburner.somerequirement.md) | At least one sub-condition must be satisfied. |
|  [SourceFileLvl](./bitburner.sourcefilelvl.md) |  |
|  [SourceFileRequirement](./bitburner.sourcefilerequirement.md) | Player must have this Source File. |
|  [SpawnOptions](./bitburner.spawnoptions.md) |  |
|  [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|  [StockMarketConstants](./bitburner.stockmarketconstants.md) | Constants used for the stock market game mechanic. |
|  [StockOrder](./bitburner.stockorder.md) | <p>Return value of [getOrders](./bitburner.tix.getorders.md)</p><p>Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md)</p> |
|  [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
|  [StudyTask](./bitburner.studytask.md) | Study |
|  [TailProperties](./bitburner.tailproperties.md) |  |
|  [TIX](./bitburner.tix.md) | Stock market API |
|  [UserInterface](./bitburner.userinterface.md) | User Interface API. |
|  [UserInterfaceTheme](./bitburner.userinterfacetheme.md) | Interface Theme |
|  [Warehouse](./bitburner.warehouse.md) | Warehouse for a division in a city |
|  [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API |
|  [WorkFormulas](./bitburner.workformulas.md) | Work formulas |
|  [WorkStats](./bitburner.workstats.md) |  |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [BladeburnerActionName](./bitburner.bladeburneractionname.md) |  |
|  [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) |  |
|  [CodingContractData](./bitburner.codingcontractdata.md) | Coding contract data will differ depending on coding contract. |
|  [CorpEmployeePosition](./bitburner.corpemployeeposition.md) |  |
|  [CorpIndustryName](./bitburner.corpindustryname.md) |  |
|  [CorpMaterialName](./bitburner.corpmaterialname.md) |  |
|  [CorpResearchName](./bitburner.corpresearchname.md) |  |
|  [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) |  |
|  [CorpStateName](./bitburner.corpstatename.md) |  |
|  [CorpUnlockName](./bitburner.corpunlockname.md) |  |
|  [CorpUpgradeName](./bitburner.corpupgradename.md) |  |
|  [FilenameOrPID](./bitburner.filenameorpid.md) |  |
|  [GoOpponent](./bitburner.goopponent.md) |  |
|  [NSEnums](./bitburner.nsenums.md) |  |
|  [PlayerRequirement](./bitburner.playerrequirement.md) | Structured interface to requirements for joining a faction or company. For fields with numerical value &gt; 0, the player must have at least this value. For fields with numerical value &lt;<!-- -->= 0, the player must have at most this value. For "not", the sub-condition must be failed instead of passed. For "someCondition", at least one sub-condition must be passed. |
|  [ReactNode](./bitburner.reactnode.md) | <p>A stand-in for the real React.ReactNode. A [ReactElement](./bitburner.reactelement.md) is rendered dynamically with React. number and string are displayed directly. boolean, null, and undefined are ignored and not rendered. An array of ReactNodes will display all members of that array sequentially.</p><p>Use React.createElement to make the ReactElement type, see [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation.</p> |
|  [ScriptArg](./bitburner.scriptarg.md) |  |
|  [SimpleOpponentStats](./bitburner.simpleopponentstats.md) |  |
|  [SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md) |  |
|  [SleeveClassTask](./bitburner.sleeveclasstask.md) |  |
|  [SleeveCompanyTask](./bitburner.sleevecompanytask.md) |  |
|  [SleeveCrimeTask](./bitburner.sleevecrimetask.md) |  |
|  [SleeveFactionTask](./bitburner.sleevefactiontask.md) |  |
|  [SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md) |  |
|  [SleeveRecoveryTask](./bitburner.sleeverecoverytask.md) |  |
|  [SleeveSupportTask](./bitburner.sleevesupporttask.md) |  |
|  [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) |  |
|  [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
|  [Task](./bitburner.task.md) | Task |