This commit is contained in:
Olivier Gagnon 2021-11-03 00:27:21 -04:00
parent 37845c57c0
commit 2b79871c02
299 changed files with 3861 additions and 7125 deletions

1874
dist/bitburner.d.ts vendored

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

@ -1,118 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentName](./bitburner.augmentname.md)
## AugmentName type
All augmentation names.
<b>Signature:</b>
```typescript
type AugmentName =
| "Augmented Targeting I"
| "Augmented Targeting II"
| "Augmented Targeting III"
| "Synthetic Heart"
| "Synfibril Muscle"
| "Combat Rib I"
| "Combat Rib II"
| "Combat Rib III"
| "Nanofiber Weave"
| "NEMEAN Subdermal Weave"
| "Wired Reflexes"
| "Graphene Bone Lacings"
| "Bionic Spine"
| "Graphene Bionic Spine Upgrade"
| "Bionic Legs"
| "Graphene Bionic Legs Upgrade"
| "Speech Processor Implant"
| "TITN-41 Gene-Modification Injection"
| "Enhanced Social Interaction Implant"
| "BitWire"
| "Artificial Bio-neural Network Implant"
| "Artificial Synaptic Potentiation"
| "Enhanced Myelin Sheathing"
| "Synaptic Enhancement Implant"
| "Neural-Retention Enhancement"
| "DataJack"
| "Embedded Netburner Module"
| "Embedded Netburner Module Core Implant"
| "Embedded Netburner Module Core V2 Upgrade"
| "Embedded Netburner Module Core V3 Upgrade"
| "Embedded Netburner Module Analyze Engine"
| "Embedded Netburner Module Direct Memory Access Upgrade"
| "Neuralstimulator"
| "Neural Accelerator"
| "Cranial Signal Processors - Gen I"
| "Cranial Signal Processors - Gen II"
| "Cranial Signal Processors - Gen III"
| "Cranial Signal Processors - Gen IV"
| "Cranial Signal Processors - Gen V"
| "Neuronal Densification"
| "Nuoptimal Nootropic Injector Implant"
| "Speech Enhancement"
| "FocusWire"
| "PC Direct-Neural Interface"
| "PC Direct-Neural Interface Optimization Submodule"
| "PC Direct-Neural Interface NeuroNet Injector"
| "ADR-V1 Pheromone Gene"
| "ADR-V2 Pheromone Gene"
| "The Shadow's Simulacrum"
| "Hacknet Node CPU Architecture Neural-Upload"
| "Hacknet Node Cache Architecture Neural-Upload"
| "Hacknet Node NIC Architecture Neural-Upload"
| "Hacknet Node Kernel Direct-Neural Interface"
| "Hacknet Node Core Direct-Neural Interface"
| "NeuroFlux Governor"
| "Neurotrainer I"
| "Neurotrainer II"
| "Neurotrainer III"
| "HyperSight Corneal Implant"
| "LuminCloaking-V1 Skin Implant"
| "LuminCloaking-V2 Skin Implant"
| "HemoRecirculator"
| "SmartSonar Implant"
| "Power Recirculation Core"
| "QLink"
| "The Red Pill"
| "SPTN-97 Gene Modification"
| "ECorp HVMind Implant"
| "CordiARC Fusion Reactor"
| "SmartJaw"
| "Neotra"
| "Xanipher"
| "nextSENS Gene Modification"
| "OmniTek InfoLoad"
| "Photosynthetic Cells"
| "BitRunners Neurolink"
| "The Black Hand"
| "CRTX42-AA Gene Modification"
| "Neuregen Gene Modification"
| "CashRoot Starter Kit"
| "NutriGen Implant"
| "INFRARET Enhancement"
| "DermaForce Particle Barrier"
| "Graphene BranchiBlades Upgrade"
| "Graphene Bionic Arms Upgrade"
| "BrachiBlades"
| "Bionic Arms"
| "Social Negotiation Assistant (S.N.A)"
| "EsperTech Bladeburner Eyewear"
| "EMS-4 Recombination"
| "ORION-MKIV Shoulder"
| "Hyperion Plasma Cannon V1"
| "Hyperion Plasma Cannon V2"
| "GOLEM Serum"
| "Vangelis Virus"
| "Vangelis Virus 3.0"
| "I.N.T.E.R.L.I.N.K.E.D"
| "Blade's Runners"
| "BLADE-51b Tesla Armor"
| "BLADE-51b Tesla Armor: Power Cells Upgrade"
| "BLADE-51b Tesla Armor: Energy Shielding Upgrade"
| "BLADE-51b Tesla Armor: Unibeam Upgrade"
| "BLADE-51b Tesla Armor: Omnibeam Upgrade"
| "BLADE-51b Tesla Armor: IPU Upgrade"
| "The Blade's Simulacrum";
```

@ -17,5 +17,5 @@ interface AugmentPair
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost | | [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost |
| [name](./bitburner.augmentpair.name.md) | [AugmentName](./bitburner.augmentname.md) | augmentation name | | [name](./bitburner.augmentpair.name.md) | string | augmentation name |

@ -9,5 +9,5 @@ augmentation name
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
name: AugmentName; name: string;
``` ```

@ -4,27 +4,20 @@
## Bladeburner.getActionAutolevel() method ## Bladeburner.getActionAutolevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get wether an action is set to autolevel.
Return a boolean indicating whether or not this action is currently set to autolevel.
Returns false if an invalid action is specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionAutolevel( getActionAutolevel(type: string, name: string): boolean;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): boolean;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +29,7 @@ True if the action is set to autolevel, and false otherwise.
RAM cost: 4 GB RAM cost: 4 GB
Return a boolean indicating whether or not this action is currently set to autolevel.
Returns false if an invalid action is specified.

@ -4,27 +4,20 @@
## Bladeburner.getActionCountRemaining() method ## Bladeburner.getActionCountRemaining() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get action count remaining.
Returns the remaining count of the specified action.
Note that this is meant to be used for Contracts and Operations. This function will return Infinity for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionCountRemaining( getActionCountRemaining(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +29,7 @@ Remaining count of the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the remaining count of the specified action.
Note that this is meant to be used for Contracts and Operations. This function will return Infinity for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.

@ -4,27 +4,20 @@
## Bladeburner.getActionCurrentLevel() method ## Bladeburner.getActionCurrentLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get the current level of an action.
Returns the current level of this action.
Returns -1 if an invalid action is specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionCurrentLevel( getActionCurrentLevel(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +29,7 @@ Current level of the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the current level of this action.
Returns -1 if an invalid action is specified.

@ -4,25 +4,20 @@
## Bladeburner.getActionEstimatedSuccessChance() method ## Bladeburner.getActionEstimatedSuccessChance() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get estimate success chance of an action.
Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionEstimatedSuccessChance( getActionEstimatedSuccessChance(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -34,3 +29,5 @@ Estimated success chance for the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).

@ -4,27 +4,20 @@
## Bladeburner.getActionMaxLevel() method ## Bladeburner.getActionMaxLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get the maximum level of an action.
Returns the maximum level for this action.
Returns -1 if an invalid action is specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionMaxLevel( getActionMaxLevel(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +29,7 @@ Maximum level of the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the maximum level for this action.
Returns -1 if an invalid action is specified.

@ -4,26 +4,20 @@
## Bladeburner.getActionRepGain() method ## Bladeburner.getActionRepGain() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get the reputation gain of an action.
Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an average and the real reputation gain may vary slightly from this value.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionRepGain( getActionRepGain(type: string, name: string, level: number): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
level: number,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
| level | number | Optional action level at which to calculate the gain | | level | number | Optional action level at which to calculate the gain |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +30,5 @@ Average Bladeburner reputation gain for successfully completing the specified ac
RAM cost: 4 GB RAM cost: 4 GB
Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an average and the real reputation gain may vary slightly from this value.

@ -4,33 +4,30 @@
## Bladeburner.getActionTime() method ## Bladeburner.getActionTime() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get the time to complete an action.
Returns the number of seconds it takes to complete the specified action
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getActionTime( getActionTime(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
number number
Number of seconds it takes to complete the specified action. Number of milliseconds it takes to complete the specified action.
## Remarks ## Remarks
RAM cost: 4 GB RAM cost: 4 GB
Returns the number of seconds it takes to complete the specified action

@ -4,18 +4,16 @@
## Bladeburner.getBlackOpNames() method ## Bladeburner.getBlackOpNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. List all black ops.
Returns an array of strings containing the names of all Bladeburner Black Ops.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getBlackOpNames(): BladeburnerBlackOps[]; getBlackOpNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[BladeburnerBlackOps](./bitburner.bladeburnerblackops.md)<!-- -->\[\] string\[\]
Array of strings containing the names of all Bladeburner Black Ops. Array of strings containing the names of all Bladeburner Black Ops.
@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner Black Ops.
RAM cost: 0.4 GB RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner Black Ops.

@ -4,23 +4,19 @@
## Bladeburner.getBlackOpRank() method ## Bladeburner.getBlackOpRank() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get black op required rank.
Returns the rank required to complete this BlackOp.
Returns -1 if an invalid action is specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getBlackOpRank(name: BladeburnerBlackOps): number; getBlackOpRank(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of BlackOp. Must be an exact match. | | name | string | Name of BlackOp. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -32,3 +28,7 @@ Rank required to complete this BlackOp.
RAM cost: 2 GB RAM cost: 2 GB
Returns the rank required to complete this BlackOp.
Returns -1 if an invalid action is specified.

@ -4,13 +4,7 @@
## Bladeburner.getBonusTime() method ## Bladeburner.getBonusTime() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get bladeburner bonus time.
Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but youve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.
<b>Signature:</b> <b>Signature:</b>
@ -21,9 +15,15 @@ getBonusTime(): number;
number number
Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.
## Remarks ## Remarks
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but youve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.

@ -4,18 +4,16 @@
## Bladeburner.getCity() method ## Bladeburner.getCity() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get current city.
Returns the city that the player is currently in (for Bladeburner).
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getCity(): City; getCity(): string;
``` ```
<b>Returns:</b> <b>Returns:</b>
[City](./bitburner.city.md) string
City that the player is currently in (for Bladeburner). City that the player is currently in (for Bladeburner).
@ -23,3 +21,5 @@ City that the player is currently in (for Bladeburner).
RAM cost: 4 GB RAM cost: 4 GB
Returns the city that the player is currently in (for Bladeburner).

@ -4,21 +4,19 @@
## Bladeburner.getCityChaos() method ## Bladeburner.getCityChaos() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get chaos of a city.
Returns the chaos in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getCityChaos(name: City): number; getCityChaos(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [City](./bitburner.city.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -30,3 +28,5 @@ Chaos in the specified city.
RAM cost: 4 GB RAM cost: 4 GB
Returns the chaos in the specified city, or -1 if an invalid city was specified.

@ -4,21 +4,19 @@
## Bladeburner.getCityCommunities() method ## Bladeburner.getCityCommunities() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get number of communities in a city.
Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getCityCommunities(name: City): number; getCityCommunities(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [City](./bitburner.city.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -30,3 +28,5 @@ Number of Synthoids communities in the specified city.
RAM cost: 4 GB RAM cost: 4 GB
Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.

@ -4,21 +4,19 @@
## Bladeburner.getCityEstimatedPopulation() method ## Bladeburner.getCityEstimatedPopulation() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get estimated population in city.
Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getCityEstimatedPopulation(name: City): number; getCityEstimatedPopulation(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [City](./bitburner.city.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -30,3 +28,5 @@ Estimated number of Synthoids in the specified city.
RAM cost: 4 GB RAM cost: 4 GB
Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.

@ -4,18 +4,16 @@
## Bladeburner.getContractNames() method ## Bladeburner.getContractNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. List all contracts.
Returns an array of strings containing the names of all Bladeburner contracts.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getContractNames(): BladeburnerContracts[]; getContractNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[BladeburnerContracts](./bitburner.bladeburnercontracts.md)<!-- -->\[\] string\[\]
Array of strings containing the names of all Bladeburner contracts. Array of strings containing the names of all Bladeburner contracts.
@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner contracts.
RAM cost: 0.4 GB RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner contracts.

@ -4,9 +4,7 @@
## Bladeburner.getCurrentAction() method ## Bladeburner.getCurrentAction() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get current action.
Returns an object that represents the players current Bladeburner action. If the player is not performing an action, the function will return an object with the type property set to “Idle”.
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Object that represents the players current Bladeburner action.
RAM cost: 1 GB RAM cost: 1 GB
Returns an object that represents the players current Bladeburner action. If the player is not performing an action, the function will return an object with the type property set to “Idle”.

@ -4,18 +4,16 @@
## Bladeburner.getGeneralActionNames() method ## Bladeburner.getGeneralActionNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. List all general actions.
Returns an array of strings containing the names of all general Bladeburner actions.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getGeneralActionNames(): BladeburnerGenActions[]; getGeneralActionNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[BladeburnerGenActions](./bitburner.bladeburnergenactions.md)<!-- -->\[\] string\[\]
Array of strings containing the names of all general Bladeburner actions. Array of strings containing the names of all general Bladeburner actions.
@ -23,3 +21,5 @@ Array of strings containing the names of all general Bladeburner actions.
RAM cost: 0.4 GB RAM cost: 0.4 GB
Returns an array of strings containing the names of all general Bladeburner actions.

@ -4,18 +4,16 @@
## Bladeburner.getOperationNames() method ## Bladeburner.getOperationNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. List all operations.
Returns an array of strings containing the names of all Bladeburner operations.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getOperationNames(): BladeburnerOperations[]; getOperationNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[BladeburnerOperations](./bitburner.bladeburneroperations.md)<!-- -->\[\] string\[\]
Array of strings containing the names of all Bladeburner operations. Array of strings containing the names of all Bladeburner operations.
@ -23,3 +21,5 @@ Array of strings containing the names of all Bladeburner operations.
RAM cost: 0.4 GB RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner operations.

@ -4,9 +4,7 @@
## Bladeburner.getRank() method ## Bladeburner.getRank() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get player bladeburner rank.
Returns the players Bladeburner Rank.
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Players Bladeburner Rank.
RAM cost: 4 GB RAM cost: 4 GB
Returns the players Bladeburner Rank.

@ -4,23 +4,19 @@
## Bladeburner.getSkillLevel() method ## Bladeburner.getSkillLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get skill level.
This function returns your level in the specified skill.
The function returns -1 if an invalid skill name is passed in.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getSkillLevel(name: BladeburnerSkills): number; getSkillLevel(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -32,3 +28,7 @@ Level in the specified skill.
RAM cost: 4 GB RAM cost: 4 GB
This function returns your level in the specified skill.
The function returns -1 if an invalid skill name is passed in.

@ -4,18 +4,16 @@
## Bladeburner.getSkillNames() method ## Bladeburner.getSkillNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. List all skills.
Returns an array of strings containing the names of all general Bladeburner skills.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getSkillNames(): BladeburnerSkills[]; getSkillNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[BladeburnerSkills](./bitburner.bladeburnerskills.md)<!-- -->\[\] string\[\]
Array of strings containing the names of all general Bladeburner skills. Array of strings containing the names of all general Bladeburner skills.
@ -23,3 +21,5 @@ Array of strings containing the names of all general Bladeburner skills.
RAM cost: 0.4 GB RAM cost: 0.4 GB
Returns an array of strings containing the names of all general Bladeburner skills.

@ -4,9 +4,7 @@
## Bladeburner.getSkillPoints() method ## Bladeburner.getSkillPoints() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get bladeburner skill points.
Returns the number of Bladeburner skill points you have.
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Number of Bladeburner skill points you have.
RAM cost: 4 GB RAM cost: 4 GB
Returns the number of Bladeburner skill points you have.

@ -4,23 +4,19 @@
## Bladeburner.getSkillUpgradeCost() method ## Bladeburner.getSkillUpgradeCost() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get cost to upgrade skill.
This function returns the number of skill points needed to upgrade the specified skill.
The function returns -1 if an invalid skill name is passed in.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getSkillUpgradeCost(name: BladeburnerSkills): number; getSkillUpgradeCost(name: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -32,3 +28,7 @@ Number of skill points needed to upgrade the specified skill.
RAM cost: 4 GB RAM cost: 4 GB
This function returns the number of skill points needed to upgrade the specified skill.
The function returns -1 if an invalid skill name is passed in.

@ -4,9 +4,7 @@
## Bladeburner.getStamina() method ## Bladeburner.getStamina() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get bladeburner stamina.
Returns an array with two elements: \* \[Current stamina, Max stamina\]
<b>Signature:</b> <b>Signature:</b>
@ -21,7 +19,7 @@ Array containing current stamina and max stamina.
## Remarks ## Remarks
RAM cost: 4 GB RAM cost: 4 GB Returns an array with two elements: \* \[Current stamina, Max stamina\]
## Example ## Example

@ -4,27 +4,20 @@
## Bladeburner.getTeamSize() method ## Bladeburner.getTeamSize() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Get team size.
Returns the number of Bladeburner team members you have assigned to the specified action.
Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getTeamSize( getTeamSize(type: string, name: string): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
<b>Returns:</b> <b>Returns:</b>
@ -36,3 +29,7 @@ Number of Bladeburner team members that were assigned to the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the number of Bladeburner team members you have assigned to the specified action.
Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.

@ -4,13 +4,7 @@
## Bladeburner.joinBladeburnerDivision() method ## Bladeburner.joinBladeburnerDivision() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Join the bladeburner division.
Attempts to join the Bladeburner division.
Returns true if you successfully join the Bladeburner division, or if you are already a member.
Returns false otherwise.
<b>Signature:</b> <b>Signature:</b>
@ -27,3 +21,9 @@ True if you successfully join the Bladeburner division, or if you are already a
RAM cost: 4 GB RAM cost: 4 GB
Attempts to join the Bladeburner division.
Returns true if you successfully join the Bladeburner division, or if you are already a member.
Returns false otherwise.

@ -4,13 +4,7 @@
## Bladeburner.joinBladeburnerFaction() method ## Bladeburner.joinBladeburnerFaction() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Join the bladeburner faction.
Attempts to join the Bladeburner faction.
Returns true if you successfully join the Bladeburner faction, or if you are already a member.
Returns false otherwise.
<b>Signature:</b> <b>Signature:</b>
@ -25,5 +19,9 @@ True if you successfully join the Bladeburner faction, or if you are already a m
## Remarks ## Remarks
RAM cost: 4 GB RAM cost: 4 GB Attempts to join the Bladeburner faction.
Returns true if you successfully join the Bladeburner faction, or if you are already a member.
Returns false otherwise.

@ -4,6 +4,7 @@
## Bladeburner interface ## Bladeburner interface
Bladeburner API
<b>Signature:</b> <b>Signature:</b>
@ -11,42 +12,46 @@
export interface Bladeburner export interface Bladeburner
``` ```
## Remarks
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this API.
## Methods ## Methods
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Return a boolean indicating whether or not this action is currently set to autolevel.<!-- -->Returns false if an invalid action is specified. | | [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get wether an action is set to autolevel. |
| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the remaining count of the specified action.<!-- -->Note that this is meant to be used for Contracts and Operations. This function will return Infinity for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. | | [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. |
| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the current level of this action.<!-- -->Returns -1 if an invalid action is specified. | | [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. |
| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). | | [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. |
| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the maximum level for this action.<!-- -->Returns -1 if an invalid action is specified. | | [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. |
| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an average and the real reputation gain may vary slightly from this value. | | [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. |
| [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the number of seconds it takes to complete the specified action | | [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | Get the time to complete an action. |
| [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array of strings containing the names of all Bladeburner Black Ops. | | [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | List all black ops. |
| [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the rank required to complete this BlackOp.<!-- -->Returns -1 if an invalid action is specified. | | [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | Get black op required rank. |
| [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.<!-- -->“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.<!-- -->“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but youve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. | | [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | Get bladeburner bonus time. |
| [getCity()](./bitburner.bladeburner.getcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the city that the player is currently in (for Bladeburner). | | [getCity()](./bitburner.bladeburner.getcity.md) | Get current city. |
| [getCityChaos(name)](./bitburner.bladeburner.getcitychaos.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the chaos in the specified city, or -1 if an invalid city was specified. | | [getCityChaos(name)](./bitburner.bladeburner.getcitychaos.md) | Get chaos of a city. |
| [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. | | [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | Get number of communities in a city. |
| [getCityEstimatedPopulation(name)](./bitburner.bladeburner.getcityestimatedpopulation.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. | | [getCityEstimatedPopulation(name)](./bitburner.bladeburner.getcityestimatedpopulation.md) | Get estimated population in city. |
| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array of strings containing the names of all Bladeburner contracts. | | [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | List all contracts. |
| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an object that represents the players current Bladeburner action. If the player is not performing an action, the function will return an object with the type property set to “Idle”. | | [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | Get current action. |
| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array of strings containing the names of all general Bladeburner actions. | | [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | List all general actions. |
| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array of strings containing the names of all Bladeburner operations. | | [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | List all operations. |
| [getRank()](./bitburner.bladeburner.getrank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the players Bladeburner Rank. | | [getRank()](./bitburner.bladeburner.getrank.md) | Get player bladeburner rank. |
| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->This function returns your level in the specified skill.<!-- -->The function returns -1 if an invalid skill name is passed in. | | [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. |
| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array of strings containing the names of all general Bladeburner skills. | | [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. |
| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the number of Bladeburner skill points you have. | | [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. |
| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->This function returns the number of skill points needed to upgrade the specified skill.<!-- -->The function returns -1 if an invalid skill name is passed in. | | [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. |
| [getStamina()](./bitburner.bladeburner.getstamina.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns an array with two elements: \* \[Current stamina, Max stamina\] | | [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. |
| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Returns the number of Bladeburner team members you have assigned to the specified action.<!-- -->Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. | | [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. |
| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Attempts to join the Bladeburner division.<!-- -->Returns true if you successfully join the Bladeburner division, or if you are already a member.<!-- -->Returns false otherwise. | | [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. |
| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Attempts to join the Bladeburner faction.<!-- -->Returns true if you successfully join the Bladeburner faction, or if you are already a member.<!-- -->Returns false otherwise. | | [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | Join the bladeburner faction. |
| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Enable/disable autoleveling for the specified action. | | [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | Set an action autolevel. |
| [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Set the level for the specified action. | | [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | Set the level of an action. |
| [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Set the team size for the specified Bladeburner action.<!-- -->Returns the team size that was set, or -1 if the function failed. | | [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | Set team size. |
| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. | | [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. |
| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Stops the current Bladeburner action. | | [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. |
| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Attempts to switch to the specified city (for Bladeburner only).<!-- -->Returns true if successful, and false otherwise | | [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. |
| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.<!-- -->Attempts to upgrade the specified Bladeburner skill.<!-- -->Returns true if the skill is successfully upgraded, and false otherwise. | | [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. |

@ -4,26 +4,20 @@
## Bladeburner.setActionAutolevel() method ## Bladeburner.setActionAutolevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Set an action autolevel.
Enable/disable autoleveling for the specified action.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
setActionAutolevel( setActionAutolevel(type: string, name: string, autoLevel: boolean): void;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
autoLevel: boolean,
): void;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
| autoLevel | boolean | Whether or not to autolevel this action | | autoLevel | boolean | Whether or not to autolevel this action |
<b>Returns:</b> <b>Returns:</b>
@ -34,3 +28,5 @@ void
RAM cost: 4 GB RAM cost: 4 GB
Enable/disable autoleveling for the specified action.

@ -4,26 +4,20 @@
## Bladeburner.setActionLevel() method ## Bladeburner.setActionLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Set the level of an action.
Set the level for the specified action.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
setActionLevel( setActionLevel(type: string, name: string, level: number): void;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
level: number,
): void;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
| level | number | Level to set this action to. | | level | number | Level to set this action to. |
<b>Returns:</b> <b>Returns:</b>
@ -34,3 +28,5 @@ void
RAM cost: 4 GB RAM cost: 4 GB
Set the level for the specified action.

@ -4,28 +4,20 @@
## Bladeburner.setTeamSize() method ## Bladeburner.setTeamSize() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Set team size.
Set the team size for the specified Bladeburner action.
Returns the team size that was set, or -1 if the function failed.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
setTeamSize( setTeamSize(type: string, name: string, size: number): number;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
size: number,
): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | | name | string | Name of action. Must be an exact match. |
| size | number | Number of team members to set. Will be converted using Math.round(). | | size | number | Number of team members to set. Will be converted using Math.round(). |
<b>Returns:</b> <b>Returns:</b>
@ -38,3 +30,7 @@ Number of Bladeburner team members you assigned to the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Set the team size for the specified Bladeburner action.
Returns the team size that was set, or -1 if the function failed.

@ -4,25 +4,20 @@
## Bladeburner.startAction() method ## Bladeburner.startAction() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Start an action.
Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
startAction( startAction(type: string, name: string): boolean;
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): boolean;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | | type | string | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match | | name | string | Name of action. Must be an exact match |
<b>Returns:</b> <b>Returns:</b>
@ -34,3 +29,5 @@ True if the action was started successfully, and false otherwise.
RAM cost: 4 GB RAM cost: 4 GB
Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.

@ -4,9 +4,7 @@
## Bladeburner.stopBladeburnerAction() method ## Bladeburner.stopBladeburnerAction() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Stop current action.
Stops the current Bladeburner action.
<b>Signature:</b> <b>Signature:</b>
@ -21,3 +19,5 @@ void
RAM cost: 2 GB RAM cost: 2 GB
Stops the current Bladeburner action.

@ -4,23 +4,19 @@
## Bladeburner.switchCity() method ## Bladeburner.switchCity() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Travel to another city in bladeburner.
Attempts to switch to the specified city (for Bladeburner only).
Returns true if successful, and false otherwise
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
switchCity(name: City): boolean; switchCity(name: string): boolean;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [City](./bitburner.city.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -30,5 +26,7 @@ true if successful, and false otherwise
## Remarks ## Remarks
RAM cost: 4 GB RAM cost: 4 GB Attempts to switch to the specified city (for Bladeburner only).
Returns true if successful, and false otherwise

@ -4,23 +4,19 @@
## Bladeburner.upgradeSkill() method ## Bladeburner.upgradeSkill() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. Upgrade skill.
Attempts to upgrade the specified Bladeburner skill.
Returns true if the skill is successfully upgraded, and false otherwise.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
upgradeSkill(name: BladeburnerSkills): boolean; upgradeSkill(name: string): boolean;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | | name | string | |
<b>Returns:</b> <b>Returns:</b>
@ -32,3 +28,7 @@ true if the skill is successfully upgraded, and false otherwise.
RAM cost: 4 GB RAM cost: 4 GB
Attempts to upgrade the specified Bladeburner skill.
Returns true if the skill is successfully upgraded, and false otherwise.

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerActTypes](./bitburner.bladeburneracttypes.md)
## BladeburnerActTypes type
All Bladeburner action types.
<b>Signature:</b>
```typescript
type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general";
```

@ -1,34 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md)
## BladeburnerBlackOps type
All Bladeburner black ops.
<b>Signature:</b>
```typescript
type BladeburnerBlackOps =
| "Operation Typhoon"
| "Operation Zero"
| "Operation X"
| "Operation Titan"
| "Operation Ares"
| "Operation Archangel"
| "Operation Juggernaut"
| "Operation Red Dragon"
| "Operation K"
| "Operation Deckard"
| "Operation Tyrell"
| "Operation Wallace"
| "Operation Shoulder of Orion"
| "Operation Hyron"
| "Operation Morpheus"
| "Operation Ion Storm"
| "Operation Annihilus"
| "Operation Ultron"
| "Operation Centurion"
| "Operation Vindictus"
| "Operation Daedalus";
```

@ -1,12 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerContracts](./bitburner.bladeburnercontracts.md)
## BladeburnerContracts type
<b>Signature:</b>
```typescript
type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement";
```

@ -16,6 +16,6 @@ interface BladeburnerCurAction
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [name](./bitburner.bladeburnercuraction.name.md) | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of Action | | [name](./bitburner.bladeburnercuraction.name.md) | string | Name of Action |
| [type](./bitburner.bladeburnercuraction.type.md) | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) \| "Idle" | Type of Action | | [type](./bitburner.bladeburnercuraction.type.md) | string | Type of Action |

@ -9,5 +9,5 @@ Name of Action
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; name: string;
``` ```

@ -9,5 +9,5 @@ Type of Action
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
type: BladeburnerActTypes | "Idle"; type: string;
``` ```

@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerGenActions](./bitburner.bladeburnergenactions.md)
## BladeburnerGenActions type
All Bladeburner General Actions.
<b>Signature:</b>
```typescript
type BladeburnerGenActions =
| "Training"
| "Field Analysis"
| "Recruitment"
| "Diplomacy"
| "Hyperbolic Regeneration Chamber";
```

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerOperations](./bitburner.bladeburneroperations.md)
## BladeburnerOperations type
All Bladeburner Ops.
<b>Signature:</b>
```typescript
type BladeburnerOperations =
| "Investigation"
| "Undercover Operation"
| "Sting Operation"
| "Raid"
| "Stealth Retirement Operation"
| "Assassination";
```

@ -1,27 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerSkills](./bitburner.bladeburnerskills.md)
## BladeburnerSkills type
All Bladeburner Skills.
<b>Signature:</b>
```typescript
type BladeburnerSkills =
| "Blade's Intuition"
| "Cloak"
| "Marksman"
| "Weapon Proficiency"
| "Short-Circuit"
| "Digital Observer"
| "Tracer"
| "Overclock"
| "Reaper"
| "Evasive System"
| "Datamancer"
| "Cyber's Edge"
| "Hands of Midas"
| "Hyperdrive";
```

@ -9,5 +9,5 @@ Name of city you are currently in
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
city: City; city: string;
``` ```

@ -9,5 +9,5 @@ Array of all companies at which you have jobs
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
company: CompanyName[]; company: string[];
``` ```

@ -9,5 +9,5 @@ Array of factions you are currently a member of
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
factions: FactionName[]; factions: string[];
``` ```

@ -9,5 +9,5 @@ Array of job positions for all companies you are employed at. Same order as 'job
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
jobTitle: CompanyField[]; jobTitle: string[];
``` ```

@ -16,11 +16,11 @@ interface CharacterInfo
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [bitnode](./bitburner.characterinfo.bitnode.md) | number | Current BitNode number | | [bitnode](./bitburner.characterinfo.bitnode.md) | number | Current BitNode number |
| [city](./bitburner.characterinfo.city.md) | [City](./bitburner.city.md) | Name of city you are currently in | | [city](./bitburner.characterinfo.city.md) | string | Name of city you are currently in |
| [company](./bitburner.characterinfo.company.md) | [CompanyName](./bitburner.companyname.md)<!-- -->\[\] | Array of all companies at which you have jobs | | [company](./bitburner.characterinfo.company.md) | string\[\] | Array of all companies at which you have jobs |
| [factions](./bitburner.characterinfo.factions.md) | [FactionName](./bitburner.factionname.md)<!-- -->\[\] | Array of factions you are currently a member of | | [factions](./bitburner.characterinfo.factions.md) | string\[\] | Array of factions you are currently a member of |
| [hp](./bitburner.characterinfo.hp.md) | number | Current health points | | [hp](./bitburner.characterinfo.hp.md) | number | Current health points |
| [jobTitle](./bitburner.characterinfo.jobtitle.md) | [CompanyField](./bitburner.companyfield.md)<!-- -->\[\] | Array of job positions for all companies you are employed at. Same order as 'jobs' | | [jobTitle](./bitburner.characterinfo.jobtitle.md) | string\[\] | Array of job positions for all companies you are employed at. Same order as 'jobs' |
| [maxHp](./bitburner.characterinfo.maxhp.md) | number | Maximum health points | | [maxHp](./bitburner.characterinfo.maxhp.md) | number | Maximum health points |
| [mult](./bitburner.characterinfo.mult.md) | [CharacterMult](./bitburner.charactermult.md) | Object with many of the player's multipliers from Augmentations/Source Files | | [mult](./bitburner.characterinfo.mult.md) | [CharacterMult](./bitburner.charactermult.md) | Object with many of the player's multipliers from Augmentations/Source Files |
| [timeWorked](./bitburner.characterinfo.timeworked.md) | number | Timed worked in ms | | [timeWorked](./bitburner.characterinfo.timeworked.md) | number | Timed worked in ms |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [City](./bitburner.city.md)
## City type
All cities.
<b>Signature:</b>
```typescript
type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven";
```

@ -4,21 +4,21 @@
## CodingContract.attempt() method ## CodingContract.attempt() method
Attempts to solve the Coding Contract with the provided solution. Attemps a coding contract.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
attempt(answer: string | string[] | number, fn: string, host?: string): boolean; attempt(answer: string[] | number, fn: string, host?: string): boolean;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| answer | string \| string\[\] \| number | Solution for the contract. | | answer | string\[\] \| number | Solution for the contract. |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>
@ -28,5 +28,7 @@ True if the solution was correct, false otherwise.
## Remarks ## Remarks
10 GB RAM cost: 10 GB
Attempts to solve the Coding Contract with the provided solution.

@ -4,21 +4,21 @@
## CodingContract.attempt() method ## CodingContract.attempt() method
Attempts to solve the Coding Contract with the provided solution. Attemps a coding contract.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
attempt(answer: string | string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string; attempt(answer: string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| answer | string \| string\[\] \| number | Solution for the contract. | | answer | string\[\] \| number | Solution for the contract. |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
| opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. | | opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. |
<b>Returns:</b> <b>Returns:</b>
@ -29,5 +29,7 @@ True if the solution was correct, false otherwise. If the returnReward option is
## Remarks ## Remarks
10 GB RAM cost: 10 GB
Attempts to solve the Coding Contract with the provided solution.

@ -4,12 +4,12 @@
## CodingContract.getContractType() method ## CodingContract.getContractType() method
Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) Get the type of a coding contract.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getContractType(fn: string, host?: string): CodingContractTypes; getContractType(fn: string, host?: string): string;
``` ```
## Parameters ## Parameters
@ -17,11 +17,11 @@ getContractType(fn: string, host?: string): CodingContractTypes;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>
[CodingContractTypes](./bitburner.codingcontracttypes.md) string
Name describing the type of problem posed by the Coding Contract. Name describing the type of problem posed by the Coding Contract.
@ -29,3 +29,5 @@ Name describing the type of problem posed by the Coding Contract.
RAM cost: 5 GB RAM cost: 5 GB
Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)

@ -4,7 +4,7 @@
## CodingContract.getData() method ## CodingContract.getData() method
Get the data associated with the specific Coding Contract. Note that this is not the same as the contracts description. This is just the data that the contract wants you to act on in order to solve Get the input data.
<b>Signature:</b> <b>Signature:</b>
@ -17,7 +17,7 @@ getData(fn: string, host?: string): string;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>
@ -29,3 +29,5 @@ The specified contracts data;
RAM cost: 5 GB RAM cost: 5 GB
Get the data associated with the specific Coding Contract. Note that this is not the same as the contracts description. This is just the data that the contract wants you to act on in order to solve

@ -4,7 +4,7 @@
## CodingContract.getDescription() method ## CodingContract.getDescription() method
Get the full text description for the problem posed by the Coding Contract. Get the description.
<b>Signature:</b> <b>Signature:</b>
@ -17,7 +17,7 @@ getDescription(fn: string, host?: string): string;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>
@ -29,3 +29,5 @@ Contracts text description.
RAM cost: 5 GB RAM cost: 5 GB
Get the full text description for the problem posed by the Coding Contract.

@ -4,7 +4,7 @@
## CodingContract.getNumTriesRemaining() method ## CodingContract.getNumTriesRemaining() method
Get the number of tries remaining on the contract before it self-destructs. Get the number of attempt remaining.
<b>Signature:</b> <b>Signature:</b>
@ -17,7 +17,7 @@ getNumTriesRemaining(fn: string, host?: string): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| fn | string | Filename of the contract. | | fn | string | Filename of the contract. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | | host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>
@ -29,3 +29,5 @@ How many attempts are remaining for the contract;
RAM cost: 2 GB RAM cost: 2 GB
Get the number of tries remaining on the contract before it self-destructs.

@ -16,10 +16,10 @@ interface CodingContract
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [attempt(answer, fn, host)](./bitburner.codingcontract.attempt.md) | Attempts to solve the Coding Contract with the provided solution. | | [attempt(answer, fn, host)](./bitburner.codingcontract.attempt.md) | Attemps a coding contract. |
| [attempt(answer, fn, host, opts)](./bitburner.codingcontract.attempt_1.md) | Attempts to solve the Coding Contract with the provided solution. | | [attempt(answer, fn, host, opts)](./bitburner.codingcontract.attempt_1.md) | Attemps a coding contract. |
| [getContractType(fn, host)](./bitburner.codingcontract.getcontracttype.md) | Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) | | [getContractType(fn, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. |
| [getData(fn, host)](./bitburner.codingcontract.getdata.md) | Get the data associated with the specific Coding Contract. Note that this is not the same as the contracts description. This is just the data that the contract wants you to act on in order to solve | | [getData(fn, host)](./bitburner.codingcontract.getdata.md) | Get the input data. |
| [getDescription(fn, host)](./bitburner.codingcontract.getdescription.md) | Get the full text description for the problem posed by the Coding Contract. | | [getDescription(fn, host)](./bitburner.codingcontract.getdescription.md) | Get the description. |
| [getNumTriesRemaining(fn, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of tries remaining on the contract before it self-destructs. | | [getNumTriesRemaining(fn, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempt remaining. |

@ -1,29 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractTypes](./bitburner.codingcontracttypes.md)
## CodingContractTypes type
All Coding contract types.
<b>Signature:</b>
```typescript
type CodingContractTypes =
| "Find Largest Prime Factor"
| "Subarray with Maximum Sum"
| "Total Ways to Sum"
| "Spiralize Matrix"
| "Array Jumping Game"
| "Merge Overlapping Intervals"
| "Generate IP Addresses"
| "Algorithmic Stock Trader I"
| "Algorithmic Stock Trader II"
| "Algorithmic Stock Trader III"
| "Algorithmic Stock Trader IV"
| "Minimum Path Sum in a Triangle"
| "Unique Paths in a Grid I"
| "Unique Paths in a Grid II"
| "Sanitize Parentheses in Expression"
| "Find All Valid Math Expressions";
```

@ -1,26 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyField](./bitburner.companyfield.md)
## CompanyField type
All company work fields.
<b>Signature:</b>
```typescript
type CompanyField =
| "software"
| "software consultant"
| "it"
| "security engineer"
| "network engineer"
| "business"
| "business consultant"
| "security"
| "agent"
| "employee"
| "part-time employee"
| "waiter"
| "part-time waiter";
```

@ -1,62 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyName](./bitburner.companyname.md)
## CompanyName type
All companies.
<b>Signature:</b>
```typescript
type CompanyName =
// Sector-12
| "MegaCorp"
| "BladeIndustries"
| "FourSigma"
| "IcarusMicrosystems"
| "UniversalEnergy"
| "DeltaOne"
| "CIA"
| "NSA"
| "AlphaEnterprises"
| "CarmichaelSecurity"
| "FoodNStuff"
| "JoesGuns"
// Aevum
| "ECorp"
| "BachmanAndAssociates"
| "ClarkeIncorporated"
| "OmniTekIncorporated"
| "FulcrumTechnologies"
| "GalacticCybersystems"
| "AeroCorp"
| "WatchdogSecurity"
| "RhoConstruction"
| "AevumPolice"
| "NetLinkTechnologies"
// Volhaven
| "NWO"
| "HeliosLabs"
| "OmniaCybersystems"
| "LexoCorp"
| "SysCoreSecurities"
| "CompuTek"
// Chongqing
| "KuaiGongInternational"
| "SolarisSpaceSystems"
// Ishima
| "StormTechnologies"
| "NovaMedical"
| "OmegaSoftware"
// New Tokyo
| "DefComm"
| "VitaLife"
| "GlobalPharmaceuticals"
| "NoodleBar";
```

@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Crime](./bitburner.crime.md)
## Crime type
All crimes.
<b>Signature:</b>
```typescript
type Crime =
| "shoplift"
| "rob store"
| "mug"
| "larceny"
| "deal drugs"
| "bond forgery"
| "traffick arms"
| "homicide"
| "grand theft auto"
| "kidnap"
| "assassinate"
| "heist";
```

@ -1,45 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionName](./bitburner.factionname.md)
## FactionName type
All factions.
<b>Signature:</b>
```typescript
type FactionName =
| "Illuminati"
| "Daedalus"
| "The Covenant"
| "ECorp"
| "MegaCorp"
| "Bachman & Associates"
| "Blade Industries"
| "NWO"
| "Clarke Incorporated"
| "OmniTek Incorporated"
| "Four Sigma"
| "KuaiGong International"
| "Fulcrum Secret Technologies"
| "BitRunners"
| "The Black Hand"
| "NiteSec"
| "Aevum"
| "Chongqing"
| "Ishima"
| "New Tokyo"
| "Sector-12"
| "Volhaven"
| "Speakers for the Dead"
| "The Dark Army"
| "The Syndicate"
| "Silhouette"
| "Tetrads"
| "Slum Snakes"
| "Netburners"
| "Tian Di Hui"
| "CyberSec"
| "Bladeburners";
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWork](./bitburner.factionwork.md)
## FactionWork type
All faction work types.
<b>Signature:</b>
```typescript
type FactionWork = "hacking" | "field" | "security";
```

@ -4,9 +4,7 @@
## Gang.ascendMember() method ## Gang.ascendMember() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Ascend a gang member.
Ascend the specified Gang Member.
<b>Signature:</b> <b>Signature:</b>
@ -30,3 +28,5 @@ Object with info about the ascension results.
RAM cost: 4 GB RAM cost: 4 GB
Ascend the specified Gang Member.

@ -4,9 +4,7 @@
## Gang.canRecruitMember() method ## Gang.canRecruitMember() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Check if you can recruit a new gang member.
Returns boolean indicating whether a member can currently be recruited
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ True if a member can currently be recruited, false otherwise.
RAM cost: 1 GB RAM cost: 1 GB
Returns boolean indicating whether a member can currently be recruited

@ -4,13 +4,7 @@
## Gang.getBonusTime() method ## Gang.getBonusTime() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get bonus time.
Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster, up to 10x the normal speed.
<b>Signature:</b> <b>Signature:</b>
@ -21,9 +15,15 @@ getBonusTime(): number;
number number
Bonus time for the Gang mechanic in seconds. Bonus time for the Gang mechanic in milliseconds.
## Remarks ## Remarks
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster, up to 10x the normal speed.

@ -4,21 +4,19 @@
## Gang.getChanceToWinClash() method ## Gang.getChanceToWinClash() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get chance to win clash with other gang.
Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getChanceToWinClash(gangName: GangName): number; getChanceToWinClash(gangName: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| gangName | [GangName](./bitburner.gangname.md) | Target gang | | gangName | string | Target gang |
<b>Returns:</b> <b>Returns:</b>
@ -30,3 +28,5 @@ Chance you have to win a clash with the specified gang.
RAM cost: 4 GB RAM cost: 4 GB
Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage

@ -4,21 +4,19 @@
## Gang.getEquipmentCost() method ## Gang.getEquipmentCost() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get cost of equipment.
Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; getEquipmentCost(equipName: string): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | | equipName | string | Name of equipment. |
<b>Returns:</b> <b>Returns:</b>
@ -30,3 +28,5 @@ Cost to purchase the specified Equipment/Augmentation (number). Infinity for inv
RAM cost: 2 GB RAM cost: 2 GB
Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.

@ -4,18 +4,16 @@
## Gang.getEquipmentNames() method ## Gang.getEquipmentNames() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. List equipment names.
Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getEquipmentNames(): (GangEquipment | GangAugmentations)[]; getEquipmentNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
([GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md)<!-- -->)\[\] string\[\]
Names of all Equpiment/Augmentations. Names of all Equpiment/Augmentations.
@ -23,3 +21,5 @@ Names of all Equpiment/Augmentations.
RAM cost: 1 GB RAM cost: 1 GB
Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.

@ -4,25 +4,23 @@
## Gang.getEquipmentStats() method ## Gang.getEquipmentStats() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get stats of an equipment.
Get the specified equipment stats.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; getEquipmentStats(equipName: string): stringStats;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | | equipName | string | Name of equipment. |
<b>Returns:</b> <b>Returns:</b>
[GangEquipmentStats](./bitburner.gangequipmentstats.md) [stringStats](./bitburner.stringstats.md)
A dictionary containing the stats of the equipment. A dictionary containing the stats of the equipment.
@ -30,3 +28,5 @@ A dictionary containing the stats of the equipment.
RAM cost: 2 GB RAM cost: 2 GB
Get the specified equipment stats.

@ -4,25 +4,23 @@
## Gang.getEquipmentType() method ## Gang.getEquipmentType() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get type of an equipment.
Get the specified equipment type.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; getEquipmentType(equipName: string): string;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | | equipName | string | Name of equipment. |
<b>Returns:</b> <b>Returns:</b>
[GangEquipmentType](./bitburner.gangequipmenttype.md) string
Type of the equipment. Type of the equipment.
@ -30,3 +28,5 @@ Type of the equipment.
RAM cost: 2 GB RAM cost: 2 GB
Get the specified equipment type.

@ -4,9 +4,7 @@
## Gang.getGangInformation() method ## Gang.getGangInformation() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get information about your gang.
Get general information about the gang.
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Object containing general information about the gang.
RAM cost: 2 GB RAM cost: 2 GB
Get general information about the gang.

@ -4,9 +4,7 @@
## Gang.getMemberInformation() method ## Gang.getMemberInformation() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get information about a specific gang member.
Get stat and equipment-related information about a Gang Member
<b>Signature:</b> <b>Signature:</b>
@ -30,3 +28,5 @@ Object containing stat and equipment-related information about a Gang Member.
RAM cost: 2 GB RAM cost: 2 GB
Get stat and equipment-related information about a Gang Member

@ -4,9 +4,7 @@
## Gang.getMemberNames() method ## Gang.getMemberNames() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. List all gang members.
Get the names of all Gang members
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Names of all Gang members.
RAM cost: 1 GB RAM cost: 1 GB
Get the names of all Gang members

@ -4,9 +4,7 @@
## Gang.getOtherGangInformation() method ## Gang.getOtherGangInformation() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get information about the other gangs.
Get territory and power information about all gangs.
<b>Signature:</b> <b>Signature:</b>
@ -23,3 +21,5 @@ Object containing territory and power information about all gangs.
RAM cost: 2 GB RAM cost: 2 GB
Get territory and power information about all gangs.

@ -4,18 +4,16 @@
## Gang.getTaskNames() method ## Gang.getTaskNames() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. List member task names.
Get the name of all valid tasks that Gang members can be assigned to.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getTaskNames(): GangTasks[]; getTaskNames(): string[];
``` ```
<b>Returns:</b> <b>Returns:</b>
[GangTasks](./bitburner.gangtasks.md)<!-- -->\[\] string\[\]
All valid tasks that Gang members can be assigned to. All valid tasks that Gang members can be assigned to.
@ -23,3 +21,5 @@ All valid tasks that Gang members can be assigned to.
RAM cost: 1 GB RAM cost: 1 GB
Get the name of all valid tasks that Gang members can be assigned to.

@ -4,25 +4,23 @@
## Gang.getTaskStats() method ## Gang.getTaskStats() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Get stats of a task.
Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getTaskStats(name: GangTasks): GangTasksStats; getTaskStats(name: string): stringStats;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | [GangTasks](./bitburner.gangtasks.md) | Name of the task. | | name | string | Name of the task. |
<b>Returns:</b> <b>Returns:</b>
[GangTasksStats](./bitburner.gangtasksstats.md) [stringStats](./bitburner.stringstats.md)
Detailed stats of a task. Detailed stats of a task.
@ -30,3 +28,5 @@ Detailed stats of a task.
RAM cost: 1 GB RAM cost: 1 GB
Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.

@ -12,26 +12,30 @@ Gang API
interface Gang interface Gang
``` ```
## Remarks
If you are not in BitNode-2, then you must have Source-File 2 in order to use this API.
## Methods ## Methods
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Ascend the specified Gang Member. | | [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | Ascend a gang member. |
| [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Returns boolean indicating whether a member can currently be recruited | | [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | Check if you can recruit a new gang member. |
| [getBonusTime()](./bitburner.gang.getbonustime.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.<!-- -->“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.<!-- -->“Bonus time” makes the game progress faster, up to 10x the normal speed. | | [getBonusTime()](./bitburner.gang.getbonustime.md) | Get bonus time. |
| [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage | | [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | Get chance to win clash with other gang. |
| [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. | | [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | Get cost of equipment. |
| [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. | | [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | List equipment names. |
| [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the specified equipment stats. | | [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | Get stats of an equipment. |
| [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the specified equipment type. | | [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | Get type of an equipment. |
| [getGangInformation()](./bitburner.gang.getganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get general information about the gang. | | [getGangInformation()](./bitburner.gang.getganginformation.md) | Get information about your gang. |
| [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get stat and equipment-related information about a Gang Member | | [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | Get information about a specific gang member. |
| [getMemberNames()](./bitburner.gang.getmembernames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the names of all Gang members | | [getMemberNames()](./bitburner.gang.getmembernames.md) | List all gang members. |
| [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get territory and power information about all gangs. | | [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | Get information about the other gangs. |
| [getTaskNames()](./bitburner.gang.gettasknames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the name of all valid tasks that Gang members can be assigned to. | | [getTaskNames()](./bitburner.gang.gettasknames.md) | List member task names. |
| [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. | | [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | Get stats of a task. |
| [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. | | [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | Purchase an equipment for a gang member. |
| [recruitMember(name)](./bitburner.gang.recruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Attempt to recruit a new gang member.<!-- -->Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name | | [recruitMember(name)](./bitburner.gang.recruitmember.md) | Recruit a new gang member. |
| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). | | [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | Set gang member to task. |
| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.<!-- -->Set whether or not the gang should engage in territory warfare | | [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | Enable/Disable territory warfare. |

@ -4,14 +4,12 @@
## Gang.purchaseEquipment() method ## Gang.purchaseEquipment() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Purchase an equipment for a gang member.
Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; purchaseEquipment(memberName: string, equipName: string): boolean;
``` ```
## Parameters ## Parameters
@ -19,7 +17,7 @@ purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentatio
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| memberName | string | Name of Gang member to purchase the equipment for. | | memberName | string | Name of Gang member to purchase the equipment for. |
| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of Equipment/Augmentation to purchase. | | equipName | string | Name of Equipment/Augmentation to purchase. |
<b>Returns:</b> <b>Returns:</b>
@ -31,3 +29,5 @@ True if the equipment was successfully purchased. False otherwise
RAM cost: 4 GB RAM cost: 4 GB
Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.

@ -4,11 +4,7 @@
## Gang.recruitMember() method ## Gang.recruitMember() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Recruit a new gang member.
Attempt to recruit a new gang member.
Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name
<b>Signature:</b> <b>Signature:</b>
@ -32,3 +28,7 @@ True if the member was successfully recruited, false otherwise.
RAM cost: 2 GB RAM cost: 2 GB
Attempt to recruit a new gang member.
Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name

@ -4,14 +4,12 @@
## Gang.setMemberTask() method ## Gang.setMemberTask() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Set gang member to task.
Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
setMemberTask(memberName: string, taskName: GangTasks): boolean; setMemberTask(memberName: string, taskName: string): boolean;
``` ```
## Parameters ## Parameters
@ -19,7 +17,7 @@ setMemberTask(memberName: string, taskName: GangTasks): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| memberName | string | Name of Gang member to assign. | | memberName | string | Name of Gang member to assign. |
| taskName | [GangTasks](./bitburner.gangtasks.md) | Task to assign. | | taskName | string | Task to assign. |
<b>Returns:</b> <b>Returns:</b>
@ -31,3 +29,5 @@ True if the Gang Member was successfully assigned to the task, false otherwise.
RAM cost: 2 GB RAM cost: 2 GB
Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).

@ -4,9 +4,7 @@
## Gang.setTerritoryWarfare() method ## Gang.setTerritoryWarfare() method
If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. Enable/Disable territory warfare.
Set whether or not the gang should engage in territory warfare
<b>Signature:</b> <b>Signature:</b>
@ -28,3 +26,5 @@ void
RAM cost: 2 GB RAM cost: 2 GB
Set whether or not the gang should engage in territory warfare

@ -1,24 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangAugmentations](./bitburner.gangaugmentations.md)
## GangAugmentations type
All Gang augmentations.
<b>Signature:</b>
```typescript
type GangAugmentations =
| "Bionic Arms"
| "Bionic Legs"
| "Bionic Spine"
| "BrachiBlades"
| "Nanofiber Weave"
| "Synthetic Heart"
| "Synfibril Muscle"
| "BitWire"
| "Neuralstimulator"
| "DataJack"
| "Graphene Bone Lacings";
```

@ -1,34 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipment](./bitburner.gangequipment.md)
## GangEquipment type
All Gang equipment.
<b>Signature:</b>
```typescript
type GangEquipment =
| "Baseball Bat"
| "Katana"
| "Glock 18C"
| "P90C"
| "Steyr AUG"
| "AK-47"
| "M15A10 Assault Rifle"
| "AWM Sniper Rifle"
| "Bulletproof Vest"
| "Full Body Armor"
| "Liquid Body Armor"
| "Graphene Plating Armor"
| "Ford Flex V20"
| "ATX1070 Superbike"
| "Mercedes-Benz S9001"
| "White Ferrari"
| "NUKE Rootkit"
| "Soulstealer Rootkit"
| "Demon Rootkit"
| "Hmap Node"
| "Jack the Ripper";
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [agi](./bitburner.gangequipmentstats.agi.md)
## GangEquipmentStats.agi property
Agility multiplier
<b>Signature:</b>
```typescript
agi: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [cha](./bitburner.gangequipmentstats.cha.md)
## GangEquipmentStats.cha property
Charisma multiplier
<b>Signature:</b>
```typescript
cha: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [def](./bitburner.gangequipmentstats.def.md)
## GangEquipmentStats.def property
Defense multiplier
<b>Signature:</b>
```typescript
def: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [dex](./bitburner.gangequipmentstats.dex.md)
## GangEquipmentStats.dex property
Dexterity multiplier
<b>Signature:</b>
```typescript
dex: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [hack](./bitburner.gangequipmentstats.hack.md)
## GangEquipmentStats.hack property
Hacking multiplier
<b>Signature:</b>
```typescript
hack: number;
```

@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md)
## GangEquipmentStats interface
Object representing data representing a gang member equipment.
<b>Signature:</b>
```typescript
interface GangEquipmentStats
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [agi](./bitburner.gangequipmentstats.agi.md) | number | Agility multiplier |
| [cha](./bitburner.gangequipmentstats.cha.md) | number | Charisma multiplier |
| [def](./bitburner.gangequipmentstats.def.md) | number | Defense multiplier |
| [dex](./bitburner.gangequipmentstats.dex.md) | number | Dexterity multiplier |
| [hack](./bitburner.gangequipmentstats.hack.md) | number | Hacking multiplier |
| [str](./bitburner.gangequipmentstats.str.md) | number | Strength multiplier |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentStats](./bitburner.gangequipmentstats.md) &gt; [str](./bitburner.gangequipmentstats.str.md)
## GangEquipmentStats.str property
Strength multiplier
<b>Signature:</b>
```typescript
str: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangEquipmentType](./bitburner.gangequipmenttype.md)
## GangEquipmentType type
All Gang equipment type.
<b>Signature:</b>
```typescript
type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation";
```

@ -9,5 +9,5 @@ Name of faction that the gang belongs to ("Slum Snakes", etc.)
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
faction: GangName; faction: string;
``` ```

@ -16,7 +16,7 @@ interface GangGenInfo
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [faction](./bitburner.ganggeninfo.faction.md) | [GangName](./bitburner.gangname.md) | Name of faction that the gang belongs to ("Slum Snakes", etc.) | | [faction](./bitburner.ganggeninfo.faction.md) | string | Name of faction that the gang belongs to ("Slum Snakes", etc.) |
| [isHacking](./bitburner.ganggeninfo.ishacking.md) | boolean | Boolean indicating whether or not its a hacking gang | | [isHacking](./bitburner.ganggeninfo.ishacking.md) | boolean | Boolean indicating whether or not its a hacking gang |
| [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | number | Money earned per second | | [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | number | Money earned per second |
| [power](./bitburner.ganggeninfo.power.md) | number | Gang's power for territory warfare | | [power](./bitburner.ganggeninfo.power.md) | number | Gang's power for territory warfare |

@ -9,5 +9,5 @@ Array of names of all owned Augmentations
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
augmentations: GangAugmentations[]; augmentations: string[];
``` ```

Some files were not shown because too many files have changed in this diff Show More