bitburner-src/markdown/bitburner.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

7.5 KiB

Home > bitburner

bitburner package

Enumerations

Enumeration Description
CompanyPosName
CrimeType
EmployeePositions
FactionWorkType
GymType
IndustryType
LocationName Names of all locations
OrderTypes
PositionTypes
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.
CodingAttemptOptions Options to affect the behavior of CodingContract attempt.
CodingContract Coding Contract API
Corporation Corporation API
CorporationInfo General info about a corporation
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
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
RecentScript
ReputationFormulas Reputation formulas
RunningScript
Server A single server.
Singularity Singularity API
Skills
SkillsFormulas Skills formulas
sleeve Sleeve API
Sleeve
SourceFileLvl
Stanek Stanek's Gift API.
StockOrder Return value of getOrdersKeys are stock symbols, properties are arrays of StockOrderObject
StockOrderObject Value in map of StockOrder
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.
FilenameOrPID
NSEnums
PortData
ScriptArg
SleeveBladeburnerTask
SleeveClassTask
SleeveCompanyTask
SleeveCrimeTask
SleeveFactionTask
SleeveInfiltrateTask
SleeveRecoveryTask
SleeveSupportTask
SleeveSynchroTask
SleeveTask Object representing a sleeve current task.