Files
bitburner-src/markdown/bitburner.md
2025-10-14 11:51:54 -07:00

24 KiB

Home > bitburner

bitburner package

Interfaces

Interface

Description

ActiveFragment

AugmentPair

Return value of getSleevePurchasableAugs

AutocompleteData

Used for autocompletion

BackdoorRequirement

Player must have installed a backdoor on this server.

BaseTask

Base interface of all tasks.

BasicHGWOptions

Options to affect the behavior of hack, grow, and weaken.

BitNodeBooleanOptions

Note:

  • restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1.

  • disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them.

BitNodeMultipliers

All multipliers affecting the difficulty of the current challenge.

BitNodeOptions

Default value:

  • sourceFileOverrides: an empty Map

  • intelligenceOverride: undefined

  • All boolean options: false

If you specify intelligenceOverride, it must be a non-negative integer.

BitNodeRequirement

Player must be located in this BitNode.

Bladeburner

Bladeburner API

BladeburnerCurAction

Bladeburner current action.

BladeburnerFormulas

Bladeburner formulas

BladeburnerRankRequirement

Player must have at least this rank in the Bladeburner Division.

CityRequirement

Player must be located in this city.

CodingContract

Coding Contract API

CompanyPositionInfo

Company position requirements and salary.

CompanyReputationRequirement

Player must have at least this much reputation with this company.

CompanyWorkTask

Company Work

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

CreateProgramWorkTask

Create Program

CrimeStats

Data representing the internal values of a crime.

CrimeTask

Crime

Division

Corporation division

EmployedByRequirement

Player must be working for this company.

EquipmentStats

Object representing data representing a gang member equipment.

EveryRequirement

All sub-conditions must be satisfied.

Export

Export order for a material

FactionWorkTask

Faction Work

FileMetadata

Metadata of a file

FileRequirement

Player must have a specific Literature or Message file on their home computer.

Format

Format API

Formulas

Formulas API

Fragment

GameInfo

Game Information

Gang

Gang API

GangFormulas

Gang formulas

GangGenInfo

Gang general info.

GangMemberAscension

GangMemberExpGain

GangMemberInfo

GangMemberInstall

GangOtherInfoObject

GangTaskStats

Object representing data representing a gang member task.

GangTerritory

Go

IPvGO api

GoAnalysis

Tools to analyze the IPvGO subnet.

GoCheat

Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.

Grafting

Grafting API

GraftingTask

Grafting Work

HackingFormulas

Hacking formulas

HackingMultipliers

Hack related multipliers.

Hacknet

Hacknet API

HacknetCoresRequirement

Player's Hacknet devices must have at least this many total cores.

HacknetLevelsRequirement

Player's Hacknet devices must have at least this many total levels.

HacknetMultipliers

Hacknet related multipliers.

HacknetNodeConstants

Hacknet node related constants

HacknetNodesFormulas

Hacknet Node formulas

HacknetRAMRequirement

Player's Hacknet devices must have at least this much total RAM.

HacknetServerConstants

Hacknet server related constants

HacknetServersFormulas

Hacknet Server formulas

HostReturnOptions

Options to control how a server identifier (hostname or IP address) is returned. Affects the behavior of scan, getPurchasedServers, and getCurrentServer

HP

ILocation

IndustryData

Corporation industry information

Infiltration

Infiltration API.

InfiltrationLocation

InfiltrationReward

InvestmentOffer

Corporation investment offer

IStyleSettings

Interface Styles

JobTitleRequirement

Player must have this job title at some company.

KarmaRequirement

Player must have less than this much karma.

LocationRequirement

Player must be at this location within a city.

Material

Material in a warehouse

MoneyRequirement

Player must have at least this much money.

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.

NotRequirement

The sub-condition must not be satisfied.

NS

Collection of all functions passed to scripts

NumAugmentationsRequirement

Player must have at least this many augmentations installed (if positive). Player must have no augmentations installed (if zero).

NumInfiltrationsRequirement

Player must have completed this many infiltrations.

Office

Office for a division in a city.

OfficeAPI

Corporation Office API

PeopleKilledRequirement

Player must have killed at least this many people.

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

SkillRequirement

Player must have each listed skill at least this level.

Skills

SkillsFormulas

Skills formulas

Sleeve

Sleeve API

SleevePerson

SomeRequirement

At least one sub-condition must be satisfied.

SourceFileLvl

SourceFileRequirement

Player must have this Source File.

SpawnOptions

Stanek

Stanek's Gift API.

Stock

Stock market API

StockMarketConstants

Constants used for the stock market game mechanic.

StockOrder

StudyTask

Study

TailProperties

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

_ValueOf

BladeburnerActionEnumType

Action types of Bladeburner

BladeburnerActionName

BladeburnerActionType

BladeburnerActionTypeForSleeve

BladeburnerBlackOpName

BladeburnerBlackOpNameEnumType

Black Operation names of Bladeburner

BladeburnerContractName

BladeburnerContractNameEnumType

Contract names of Bladeburner

BladeburnerGeneralActionName

BladeburnerGeneralActionNameEnumType

General action names of Bladeburner

BladeburnerOperationName

BladeburnerOperationNameEnumType

Operation names of Bladeburner

BladeburnerSkillName

BladeburnerSkillNameEnumType

Skill names type of Bladeburner

CityName

CityNameEnumType

Names of all cities

CodingContractName

CodingContractNameEnumType

CodingContractObject

CodingContractSignatures

CompanyName

CompanyNameEnumType

Names of all companies

CorpEmployeePosition

CorpIndustryName

CorpMaterialName

CorpResearchName

CorpSmartSupplyOption

CorpStateName

CorpUnlockName

CorpUpgradeName

CreatingCorporationCheckResult

CreatingCorporationCheckResultEnumType

CrimeEnumType

CrimeType

FactionName

FactionNameEnumType

Names of all factions.

Warning: Spoiler ahead. This enum contains names of **all** factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.

FactionWorkEnumType

FactionWorkType

FilenameOrPID

FragmentEnumType

FragmentType

GoOpponent

GymEnumType

GymLocationName

GymLocationNameEnumType

Locations of gym

GymType

HacknetServerHashUpgrade

JobField

JobFieldEnumType

JobName

JobNameEnumType

LocationName

LocationNameEnumType

Names of all locations

NSEnums

OrderEnumType

OrderType

PlayerRequirement

Structured interface to requirements for joining a faction or company. For fields with numerical value > 0, the player must have at least this value. For fields with numerical value <= 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.

PositionEnumType

PositionType

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

SimpleOpponentStats

SleeveBladeburnerTask

SleeveClassTask

SleeveCompanyTask

SleeveCrimeTask

SleeveFactionTask

SleeveInfiltrateTask

SleeveRecoveryTask

SleeveSupportTask

SleeveSynchroTask

SleeveTask

Object representing a sleeve current task.

SpecialBladeburnerActionEnumTypeForSleeve

These special Bladeburner action types are only for Sleeve

SpecialBladeburnerActionTypeForSleeve

Task

Task

ToastVariant

ToastVariantEnumType

UniversityClassEnumType

UniversityClassType

UniversityLocationName

UniversityLocationNameEnumType

Locations of university