bitburner-src/markdown/bitburner.md

109 lines
6.8 KiB
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md)
## bitburner package
2022-01-16 00:39:37 +01:00
## Enumerations
| Enumeration | Description |
| --- | --- |
| [OrderTypes](./bitburner.ordertypes.md) | |
| [PositionTypes](./bitburner.positiontypes.md) | |
2022-04-13 07:35:35 +02:00
| [ToastVariant](./bitburner.toastvariant.md) | |
2022-01-16 00:39:37 +01:00
2021-10-30 18:34:14 +02:00
## Interfaces
| Interface | Description |
| --- | --- |
2021-12-03 22:14:13 +01:00
| [ActiveFragment](./bitburner.activefragment.md) | |
2021-10-30 21:46:34 +02:00
| [AugmentationStats](./bitburner.augmentationstats.md) | Data representing the internal values of an Augmentation. |
| [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) |
2022-03-17 21:50:46 +01:00
| [AutocompleteData](./bitburner.autocompletedata.md) | Used for autocompletion |
2021-10-30 21:46:34 +02:00
| [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. |
2021-11-03 05:27:21 +01:00
| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API |
2021-10-30 21:46:34 +02:00
| [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. |
2021-10-30 18:34:14 +02:00
| [CharacterMult](./bitburner.charactermult.md) | |
2021-10-30 21:46:34 +02:00
| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. |
2021-12-28 11:01:22 +01:00
| [CodingContract](./bitburner.codingcontract.md) | Coding Contract API |
2021-12-09 02:03:22 +01:00
| [Corporation](./bitburner.corporation.md) | Corporation API |
| [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation |
2021-10-30 21:46:34 +02:00
| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
2021-12-09 02:03:22 +01:00
| [Division](./bitburner.division.md) | Corporation division |
| [Employee](./bitburner.employee.md) | Employee in an office |
| [EmployeeJobs](./bitburner.employeejobs.md) | Object representing the number of employee in each job. |
2021-11-03 05:33:14 +01:00
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
2022-09-23 21:03:38 +02:00
| [Export](./bitburner.export.md) | Export order for a material |
| [Formulas](./bitburner.formulas.md) | Formulas API |
2021-12-03 22:14:13 +01:00
| [Fragment](./bitburner.fragment.md) | |
2021-10-30 21:46:34 +02:00
| [Gang](./bitburner.gang.md) | Gang API |
| [GangFormulas](./bitburner.gangformulas.md) | Gang formulas |
2021-10-30 21:46:34 +02:00
| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
2021-10-30 18:34:14 +02:00
| [GangMemberAscension](./bitburner.gangmemberascension.md) | |
| [GangMemberInfo](./bitburner.gangmemberinfo.md) | |
2021-11-03 05:33:14 +01:00
| [GangOtherInfo](./bitburner.gangotherinfo.md) | |
2021-10-30 18:34:14 +02:00
| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
2021-11-03 05:33:14 +01:00
| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
| [GangTerritory](./bitburner.gangterritory.md) | |
2022-03-29 21:49:31 +02:00
| [Grafting](./bitburner.grafting.md) | Grafting API |
2021-12-09 01:19:07 +01:00
| [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
2021-10-30 21:46:34 +02:00
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
| [Hacknet](./bitburner.hacknet.md) | Hacknet API |
| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
2022-01-16 00:39:37 +01:00
| [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants |
2021-12-09 01:19:07 +01:00
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
2022-01-16 00:39:37 +01:00
| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
2021-12-09 01:19:07 +01:00
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
2022-08-17 14:50:05 +02:00
| [HP](./bitburner.hp.md) | |
| [ILocation](./bitburner.ilocation.md) | |
2022-05-24 14:12:49 +02:00
| [Infiltration](./bitburner.infiltration.md) | Infiltration API. |
| [InfiltrationLocation](./bitburner.infiltrationlocation.md) | |
| [InfiltrationReward](./bitburner.infiltrationreward.md) | |
2022-01-13 19:48:54 +01:00
| [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
2021-12-09 02:03:22 +01:00
| [Material](./bitburner.material.md) | Material in a warehouse |
2022-08-17 14:50:05 +02:00
| [Multipliers](./bitburner.multipliers.md) | |
2022-01-16 00:39:37 +01:00
| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. |
2021-10-30 21:46:34 +02:00
| [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 |
2022-04-13 07:35:35 +02:00
| [NSEnums](./bitburner.nsenums.md) | |
2021-12-09 02:03:22 +01:00
| [Office](./bitburner.office.md) | Office for a division in a city. |
| [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API |
| [Player](./bitburner.player.md) | |
2022-08-17 14:50:05 +02:00
| [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) | |
2021-10-30 21:46:34 +02:00
| [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. |
2021-12-09 02:03:22 +01:00
| [Product](./bitburner.product.md) | Product in a warehouse |
2022-04-13 07:35:35 +02:00
| [RecentScript](./bitburner.recentscript.md) | |
| [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas |
| [RunningScript](./bitburner.runningscript.md) | |
2021-10-30 21:46:34 +02:00
| [Server](./bitburner.server.md) | A single server. |
| [Singularity](./bitburner.singularity.md) | Singularity API |
2022-08-17 14:50:05 +02:00
| [Skills](./bitburner.skills.md) | |
2021-12-09 01:19:07 +01:00
| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
2021-10-30 21:46:34 +02:00
| [Sleeve](./bitburner.sleeve.md) | Sleeve API |
| [SleeveInformation](./bitburner.sleeveinformation.md) | Object representing sleeve information. |
| [SleeveSkills](./bitburner.sleeveskills.md) | Object representing a sleeve stats. |
2021-10-30 18:34:14 +02:00
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
2021-12-03 22:14:13 +01:00
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
2022-01-16 00:39:37 +01:00
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)<!-- -->Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) |
2021-10-30 21:46:34 +02:00
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
| [TIX](./bitburner.tix.md) | Stock market API |
2021-12-20 19:38:21 +01:00
| [UserInterface](./bitburner.userinterface.md) | User Interface API. |
2021-12-09 02:03:22 +01:00
| [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) | |
2021-10-30 18:34:14 +02:00
2022-01-16 00:39:37 +01:00
## Type Aliases
| Type Alias | Description |
| --- | --- |
2022-08-17 14:50:05 +02:00
| [CodingContractData](./bitburner.codingcontractdata.md) | Coding contract data will differ depending on coding contract. |
2022-01-16 00:39:37 +01:00
| [FilenameOrPID](./bitburner.filenameorpid.md) | |
2022-08-17 14:50:05 +02:00
| [PortData](./bitburner.portdata.md) | |
| [ScriptArg](./bitburner.scriptarg.md) | |
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
2022-04-13 08:04:51 +02:00
| [ToastVariantValues](./bitburner.toastvariantvalues.md) | |
2022-01-16 00:39:37 +01:00