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 |
|  --- | --- |
|  [CityName](./bitburner.cityname.md) | Names of all cities |
|  [CrimeType](./bitburner.crimetype.md) |  |
|  [FactionWorkType](./bitburner.factionworktype.md) |  |
|  [GymType](./bitburner.gymtype.md) |  |
|  [JobName](./bitburner.jobname.md) |  |
|  [LocationName](./bitburner.locationname.md) | Names of all locations |
|  [OrderTypes](./bitburner.ordertypes.md) |  |
|  [PositionTypes](./bitburner.positiontypes.md) |  |
|  [ToastVariant](./bitburner.toastvariant.md) |  |
|  [UniversityClassType](./bitburner.universityclasstype.md) |  |

## 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 |
|  [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)<!-- -->. |
|  [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. |
|  [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API |
|  [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. |
|  [CodingContract](./bitburner.codingcontract.md) | Coding Contract API |
|  [CompanyPositionInfo](./bitburner.companypositioninfo.md) | Company position requirements and salary. |
|  [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 |
|  [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
|  [Division](./bitburner.division.md) | Corporation division |
|  [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
|  [Export](./bitburner.export.md) | Export order for a material |
|  [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) |  |
|  [GangOtherInfo](./bitburner.gangotherinfo.md) |  |
|  [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) |  |
|  [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
|  [GangTerritory](./bitburner.gangterritory.md) |  |
|  [Grafting](./bitburner.grafting.md) | Grafting API |
|  [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
|  [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
|  [Hacknet](./bitburner.hacknet.md) | Hacknet API |
|  [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
|  [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants |
|  [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
|  [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
|  [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
|  [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 |
|  [Material](./bitburner.material.md) | Material in a warehouse |
|  [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. |
|  [NS](./bitburner.ns.md) | Collection of all functions passed to scripts |
|  [Office](./bitburner.office.md) | Office for a division in a city. |
|  [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API |
|  [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 |
|  [RecentScript](./bitburner.recentscript.md) |  |
|  [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas |
|  [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 |
|  [Skills](./bitburner.skills.md) |  |
|  [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
|  [Sleeve](./bitburner.sleeve.md) | Sleeve API |
|  [SleevePerson](./bitburner.sleeveperson.md) |  |
|  [SourceFileLvl](./bitburner.sourcefilelvl.md) |  |
|  [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|  [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) |
|  [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 |
|  --- | --- |
|  [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) |  |
|  [CorpStateName](./bitburner.corpstatename.md) |  |
|  [CorpUnlockName](./bitburner.corpunlockname.md) |  |
|  [CorpUpgradeName](./bitburner.corpupgradename.md) |  |
|  [FilenameOrPID](./bitburner.filenameorpid.md) |  |
|  [NSEnums](./bitburner.nsenums.md) |  |
|  [PortData](./bitburner.portdata.md) |  |
|  [ScriptArg](./bitburner.scriptarg.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. |