bitburner-src/markdown/bitburner.md

Home > bitburner

bitburner package

Enumerations

Enumeration	Description
CityName	Names of all cities
CompanyName	Names of all companies
CrimeType
FactionWorkType
GymType
JobName
LocationName	Names of all locations
OrderType
PositionType
ToastVariant
UniversityClassType

Interfaces

Interface	Description
ActiveFragment
AugmentPair	Return value of getSleevePurchasableAugs
AutocompleteData	Used for autocompletion
BasicHGWOptions	Options to affect the behavior of hack, grow, and weaken.
BitNodeMultipliers	All multipliers affecting the difficulty of the current challenge.
Bladeburner	Bladeburner API
BladeburnerCurAction	Bladeburner current action.
CodingContract	Coding Contract API
CompanyPositionInfo	Company position requirements and salary.
CorpConstants	Corporation related constants
CorpIndustryData	Data for an individual industry
CorpMaterialConstantData	Corporation material information
Corporation	Corporation API
CorporationInfo	General info about a corporation
CorpProductData	Product rating information
CrimeStats	Data representing the internal values of a crime.
Division	Corporation division
EquipmentStats	Object representing data representing a gang member equipment.
Export	Export order for a material
Formulas	Formulas API
Fragment
GameInfo	Game Information
Gang	Gang API
GangFormulas	Gang formulas
GangGenInfo	Gang general info.
GangMemberAscension
GangMemberInfo
GangOtherInfo
GangOtherInfoObject
GangTaskStats	Object representing data representing a gang member task.
GangTerritory
Grafting	Grafting API
HackingFormulas	Hacking formulas
HackingMultipliers	Hack related multipliers.
Hacknet	Hacknet API
HacknetMultipliers	Hacknet related multipliers.
HacknetNodeConstants	Hacknet node related constants
HacknetNodesFormulas	Hacknet Node formulas
HacknetServerConstants	Hacknet server related constants
HacknetServersFormulas	Hacknet Server formulas
HP
ILocation
IndustryData	Corporation industry information
Infiltration	Infiltration API.
InfiltrationLocation
InfiltrationReward
InvestmentOffer	Corporation investment offer
IStyleSettings	Interface Styles
Material	Material in a warehouse
MoneySource
MoneySources
Multipliers
NetscriptPort	Object representing a port. A port is a serialized queue.
NodeStats	Object representing all the values related to a hacknet node.
NS	Collection of all functions passed to scripts
Office	Office for a division in a city.
OfficeAPI	Corporation Office API
Person
Player
ProcessInfo	A single process on a server.
Product	Product in a warehouse
ReactElement	A stand-in for the real React.ReactElement. Use React.createElement to make these. See creating an element without jsx from the official React documentation.
RecentScript
ReputationFormulas	Reputation formulas
ResetInfo	Various info about resets
RunningScript
RunOptions
Server	A server. Not all servers have all of these properties - optional properties are missing on certain servers.
Singularity	Singularity API
Skills
SkillsFormulas	Skills formulas
Sleeve	Sleeve API
SleevePerson
SourceFileLvl
Stanek	Stanek's Gift API.
StockMarketConstants	Constants used for the stockmarket game mechanic.
StockOrder	Return value of getOrders Keys are stock symbols, properties are arrays of StockOrderObject
StockOrderObject	Value in map of StockOrder
TailProperties
TIX	Stock market API
UserInterface	User Interface API.
UserInterfaceTheme	Interface Theme
Warehouse	Warehouse for a division in a city
WarehouseAPI	Corporation Warehouse API
WorkFormulas	Work formulas
WorkStats

Type Aliases

Type Alias	Description
CodingContractData	Coding contract data will differ depending on coding contract.
CorpEmployeePosition
CorpIndustryName
CorpMaterialName
CorpResearchName
CorpSmartSupplyOption
CorpStateName
CorpUnlockName
CorpUpgradeName
FilenameOrPID
NSEnums
PortData
ReactNode	A stand-in for the real React.ReactNode. A ReactElement 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. Use React.createElement to make the ReactElement type, see creating an element without jsx from the official React documentation.
ScriptArg
SleeveBladeburnerTask
SleeveClassTask
SleeveCompanyTask
SleeveCrimeTask
SleeveFactionTask
SleeveInfiltrateTask
SleeveRecoveryTask
SleeveSupportTask
SleeveSynchroTask
SleeveTask	Object representing a sleeve current task.