MISC: Change how enums are exposed in NetscriptDefinitions.d.ts (#1998)

This commit is contained in:
catloversg
2025-05-10 16:28:48 +07:00
committed by GitHub
parent 7db15a6bd2
commit 22ee7fca2c
144 changed files with 1628 additions and 1458 deletions

View File

@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [\_ValueOf](./bitburner._valueof.md)
## \_ValueOf type
**Signature:**
```typescript
type _ValueOf<T> = T[keyof T];
```

View File

@@ -9,18 +9,15 @@ Get whether an action is set to autolevel.
**Signature:**
```typescript
getActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): boolean;
getActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get action count remaining.
**Signature:**
```typescript
getActionCountRemaining(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionCountRemaining(type: BladeburnerActionType, name: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get the current level of an action.
**Signature:**
```typescript
getActionCurrentLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionCurrentLevel(type: BladeburnerActionType, name: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -10,8 +10,8 @@ Get estimate success chance of an action.
```typescript
getActionEstimatedSuccessChance(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
type: BladeburnerActionType,
name: BladeburnerActionName,
sleeveNumber?: number,
): [number, number];
```
@@ -20,8 +20,8 @@ getActionEstimatedSuccessChance(
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
| sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get the maximum level of an action.
**Signature:**
```typescript
getActionMaxLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionMaxLevel(type: BladeburnerActionType, name: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Get the reputation gain of an action.
**Signature:**
```typescript
getActionRepGain(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level?: number,
): number;
getActionRepGain(type: BladeburnerActionType, name: BladeburnerActionName, level?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
| level | number | _(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get action successes.
**Signature:**
```typescript
getActionSuccesses(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionSuccesses(type: BladeburnerActionType, name: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get the time to complete an action.
**Signature:**
```typescript
getActionTime(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionTime(type: BladeburnerActionType, name: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get chaos of a city.
**Signature:**
```typescript
getCityChaos(city: CityName | `${CityName}`): number;
getCityChaos(city: CityName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get number of communities in a city.
**Signature:**
```typescript
getCityCommunities(city: CityName | `${CityName}`): number;
getCityCommunities(city: CityName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get estimated population in city.
**Signature:**
```typescript
getCityEstimatedPopulation(city: CityName | `${CityName}`): number;
getCityEstimatedPopulation(city: CityName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get skill level.
**Signature:**
```typescript
getSkillLevel(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`): number;
getSkillLevel(skillName: BladeburnerSkillName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill. Case-sensitive and must be an exact match. |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get cost to upgrade skill.
**Signature:**
```typescript
getSkillUpgradeCost(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): number;
getSkillUpgradeCost(skillName: BladeburnerSkillName, count?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill. Case-sensitive and must be an exact match. |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. |
| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get team size.
**Signature:**
```typescript
getTeamSize(
type?: BladeburnerActionType | `${BladeburnerActionType}`,
name?: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getTeamSize(type?: BladeburnerActionType, name?: BladeburnerActionName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | _(Optional)_ Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | _(Optional)_ Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | _(Optional)_ Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | _(Optional)_ Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Set an action autolevel.
**Signature:**
```typescript
setActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
autoLevel: boolean,
): void;
setActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName, autoLevel: boolean): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
| autoLevel | boolean | Whether or not to autolevel this action |
**Returns:**

View File

@@ -9,19 +9,15 @@ Set the level of an action.
**Signature:**
```typescript
setActionLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level: number,
): void;
setActionLevel(type: BladeburnerActionType, name: BladeburnerActionName, level: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
| level | number | Level to set this action to. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Set team size.
**Signature:**
```typescript
setTeamSize(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
size: number,
): number;
setTeamSize(type: BladeburnerActionType, name: BladeburnerActionName, size: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. |
| size | number | Number of team members to set. Must be a non-negative integer. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Start an action.
**Signature:**
```typescript
startAction(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): boolean;
startAction(type: BladeburnerActionType, name: BladeburnerActionName): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match |
**Returns:**

View File

@@ -9,14 +9,14 @@ Travel to another city in Bladeburner.
**Signature:**
```typescript
switchCity(city: CityName | `${CityName}`): boolean;
switchCity(city: CityName): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive |
**Returns:**

View File

@@ -9,14 +9,14 @@ Upgrade skill.
**Signature:**
```typescript
upgradeSkill(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): boolean;
upgradeSkill(skillName: BladeburnerSkillName, count?: number): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill to be upgraded. Case-sensitive and must be an exact match. |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill to be upgraded. Case-sensitive and must be an exact match. |
| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. |
**Returns:**

View File

@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md)
## BladeburnerActionEnumType type
Action types of Bladeburner
**Signature:**
```typescript
type BladeburnerActionEnumType = {
General: "General";
Contract: "Contracts";
Operation: "Operations";
BlackOp: "Black Operations";
};
```

View File

@@ -2,22 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerActionType](./bitburner.bladeburneractiontype.md)
## BladeburnerActionType enum
## BladeburnerActionType type
Action types of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerActionType
type BladeburnerActionType = _ValueOf<BladeburnerActionEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BlackOp | <code>&quot;Black Operations&quot;</code> | |
| Contract | <code>&quot;Contracts&quot;</code> | |
| General | <code>&quot;General&quot;</code> | |
| Operation | <code>&quot;Operations&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md)

View File

@@ -9,8 +9,8 @@
```typescript
export type BladeburnerActionTypeForSleeve =
| Exclude<BladeburnerGeneralActionName, BladeburnerGeneralActionName.InciteViolence>
| Exclude<BladeburnerGeneralActionName, BladeburnerGeneralActionNameEnumType["InciteViolence"]>
| SpecialBladeburnerActionTypeForSleeve;
```
**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [BladeburnerGeneralActionName.InciteViolence](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md)
**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md)<!-- -->, [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md)

View File

@@ -2,39 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)
## BladeburnerBlackOpName enum
## BladeburnerBlackOpName type
Black Operation names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerBlackOpName
type BladeburnerBlackOpName = _ValueOf<BladeburnerBlackOpNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| OperationAnnihilus | <code>&quot;Operation Annihilus&quot;</code> | |
| OperationArchangel | <code>&quot;Operation Archangel&quot;</code> | |
| OperationAres | <code>&quot;Operation Ares&quot;</code> | |
| OperationCenturion | <code>&quot;Operation Centurion&quot;</code> | |
| OperationDaedalus | <code>&quot;Operation Daedalus&quot;</code> | |
| OperationDeckard | <code>&quot;Operation Deckard&quot;</code> | |
| OperationHyron | <code>&quot;Operation Hyron&quot;</code> | |
| OperationIonStorm | <code>&quot;Operation Ion Storm&quot;</code> | |
| OperationJuggernaut | <code>&quot;Operation Juggernaut&quot;</code> | |
| OperationK | <code>&quot;Operation K&quot;</code> | |
| OperationMorpheus | <code>&quot;Operation Morpheus&quot;</code> | |
| OperationRedDragon | <code>&quot;Operation Red Dragon&quot;</code> | |
| OperationShoulderOfOrion | <code>&quot;Operation Shoulder of Orion&quot;</code> | |
| OperationTitan | <code>&quot;Operation Titan&quot;</code> | |
| OperationTyphoon | <code>&quot;Operation Typhoon&quot;</code> | |
| OperationTyrell | <code>&quot;Operation Tyrell&quot;</code> | |
| OperationUltron | <code>&quot;Operation Ultron&quot;</code> | |
| OperationVindictus | <code>&quot;Operation Vindictus&quot;</code> | |
| OperationWallace | <code>&quot;Operation Wallace&quot;</code> | |
| OperationX | <code>&quot;Operation X&quot;</code> | |
| OperationZero | <code>&quot;Operation Zero&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md)

View File

@@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md)
## BladeburnerBlackOpNameEnumType type
Black Operation names of Bladeburner
**Signature:**
```typescript
type BladeburnerBlackOpNameEnumType = {
OperationTyphoon: "Operation Typhoon";
OperationZero: "Operation Zero";
OperationX: "Operation X";
OperationTitan: "Operation Titan";
OperationAres: "Operation Ares";
OperationArchangel: "Operation Archangel";
OperationJuggernaut: "Operation Juggernaut";
OperationRedDragon: "Operation Red Dragon";
OperationK: "Operation K";
OperationDeckard: "Operation Deckard";
OperationTyrell: "Operation Tyrell";
OperationWallace: "Operation Wallace";
OperationShoulderOfOrion: "Operation Shoulder of Orion";
OperationHyron: "Operation Hyron";
OperationMorpheus: "Operation Morpheus";
OperationIonStorm: "Operation Ion Storm";
OperationAnnihilus: "Operation Annihilus";
OperationUltron: "Operation Ultron";
OperationCenturion: "Operation Centurion";
OperationVindictus: "Operation Vindictus";
OperationDaedalus: "Operation Daedalus";
};
```

View File

@@ -2,21 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerContractName](./bitburner.bladeburnercontractname.md)
## BladeburnerContractName enum
## BladeburnerContractName type
Contract names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerContractName
type BladeburnerContractName = _ValueOf<BladeburnerContractNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BountyHunter | <code>&quot;Bounty Hunter&quot;</code> | |
| Retirement | <code>&quot;Retirement&quot;</code> | |
| Tracking | <code>&quot;Tracking&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md)

View File

@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md)
## BladeburnerContractNameEnumType type
Contract names of Bladeburner
**Signature:**
```typescript
type BladeburnerContractNameEnumType = {
Tracking: "Tracking";
BountyHunter: "Bounty Hunter";
Retirement: "Retirement";
};
```

View File

@@ -9,18 +9,14 @@ Calculate the number of times that you can upgrade a skill.
**Signature:**
```typescript
skillMaxUpgradeCount(
name: BladeburnerSkillName | `${BladeburnerSkillName}`,
level: number,
skillPoints: number,
): number;
skillMaxUpgradeCount(name: BladeburnerSkillName, level: number, skillPoints: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Skill name. It's case-sensitive and must be an exact match. |
| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill name. It's case-sensitive and must be an exact match. |
| level | number | Skill level. It must be a non-negative number. |
| skillPoints | number | Number of skill points to upgrade the skill. It must be a non-negative number. |

View File

@@ -2,24 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)
## BladeburnerGeneralActionName enum
## BladeburnerGeneralActionName type
General action names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerGeneralActionName
type BladeburnerGeneralActionName = _ValueOf<BladeburnerGeneralActionNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Diplomacy | <code>&quot;Diplomacy&quot;</code> | |
| FieldAnalysis | <code>&quot;Field Analysis&quot;</code> | |
| HyperbolicRegen | <code>&quot;Hyperbolic Regeneration Chamber&quot;</code> | |
| InciteViolence | <code>&quot;Incite Violence&quot;</code> | |
| Recruitment | <code>&quot;Recruitment&quot;</code> | |
| Training | <code>&quot;Training&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md)

View File

@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md)
## BladeburnerGeneralActionNameEnumType type
General action names of Bladeburner
**Signature:**
```typescript
type BladeburnerGeneralActionNameEnumType = {
Training: "Training";
FieldAnalysis: "Field Analysis";
Recruitment: "Recruitment";
Diplomacy: "Diplomacy";
HyperbolicRegen: "Hyperbolic Regeneration Chamber";
InciteViolence: "Incite Violence";
};
```

View File

@@ -2,24 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerOperationName](./bitburner.bladeburneroperationname.md)
## BladeburnerOperationName enum
## BladeburnerOperationName type
Operation names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerOperationName
type BladeburnerOperationName = _ValueOf<BladeburnerOperationNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Assassination | <code>&quot;Assassination&quot;</code> | |
| Investigation | <code>&quot;Investigation&quot;</code> | |
| Raid | <code>&quot;Raid&quot;</code> | |
| StealthRetirement | <code>&quot;Stealth Retirement Operation&quot;</code> | |
| Sting | <code>&quot;Sting Operation&quot;</code> | |
| Undercover | <code>&quot;Undercover Operation&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md)

View File

@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md)
## BladeburnerOperationNameEnumType type
Operation names of Bladeburner
**Signature:**
```typescript
type BladeburnerOperationNameEnumType = {
Investigation: "Investigation";
Undercover: "Undercover Operation";
Sting: "Sting Operation";
Raid: "Raid";
StealthRetirement: "Stealth Retirement Operation";
Assassination: "Assassination";
};
```

View File

@@ -2,30 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerSkillName](./bitburner.bladeburnerskillname.md)
## BladeburnerSkillName enum
## BladeburnerSkillName type
Skill names type of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerSkillName
type BladeburnerSkillName = _ValueOf<BladeburnerSkillNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BladesIntuition | <code>&quot;Blade's Intuition&quot;</code> | |
| Cloak | <code>&quot;Cloak&quot;</code> | |
| CybersEdge | <code>&quot;Cyber's Edge&quot;</code> | |
| Datamancer | <code>&quot;Datamancer&quot;</code> | |
| DigitalObserver | <code>&quot;Digital Observer&quot;</code> | |
| EvasiveSystem | <code>&quot;Evasive System&quot;</code> | |
| HandsOfMidas | <code>&quot;Hands of Midas&quot;</code> | |
| Hyperdrive | <code>&quot;Hyperdrive&quot;</code> | |
| Overclock | <code>&quot;Overclock&quot;</code> | |
| Reaper | <code>&quot;Reaper&quot;</code> | |
| ShortCircuit | <code>&quot;Short-Circuit&quot;</code> | |
| Tracer | <code>&quot;Tracer&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md)

View File

@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md)
## BladeburnerSkillNameEnumType type
Skill names type of Bladeburner
**Signature:**
```typescript
type BladeburnerSkillNameEnumType = {
BladesIntuition: "Blade's Intuition";
Cloak: "Cloak";
ShortCircuit: "Short-Circuit";
DigitalObserver: "Digital Observer";
Tracer: "Tracer";
Overclock: "Overclock";
Reaper: "Reaper";
EvasiveSystem: "Evasive System";
Datamancer: "Datamancer";
CybersEdge: "Cyber's Edge";
HandsOfMidas: "Hands of Midas";
Hyperdrive: "Hyperdrive";
};
```

View File

@@ -2,24 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityName](./bitburner.cityname.md)
## CityName enum
## CityName type
Names of all cities
**Signature:**
```typescript
declare enum CityName
type CityName = _ValueOf<CityNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Aevum | <code>&quot;Aevum&quot;</code> | |
| Chongqing | <code>&quot;Chongqing&quot;</code> | |
| Ishima | <code>&quot;Ishima&quot;</code> | |
| NewTokyo | <code>&quot;New Tokyo&quot;</code> | |
| Sector12 | <code>&quot;Sector-12&quot;</code> | |
| Volhaven | <code>&quot;Volhaven&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [CityNameEnumType](./bitburner.citynameenumtype.md)

View File

@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityNameEnumType](./bitburner.citynameenumtype.md)
## CityNameEnumType type
Names of all cities
**Signature:**
```typescript
type CityNameEnumType = {
Aevum: "Aevum";
Chongqing: "Chongqing";
Sector12: "Sector-12";
NewTokyo: "New Tokyo";
Ishima: "Ishima";
Volhaven: "Volhaven";
};
```

View File

@@ -9,7 +9,7 @@ Get the type of a coding contract.
**Signature:**
```typescript
getContractType(filename: string, host?: string): `${CodingContractName}`;
getContractType(filename: string, host?: string): CodingContractName;
```
## Parameters
@@ -21,7 +21,7 @@ getContractType(filename: string, host?: string): `${CodingContractName}`;
**Returns:**
\`${[CodingContractName](./bitburner.codingcontractname.md)<!-- -->}\`
[CodingContractName](./bitburner.codingcontractname.md)
Name describing the type of problem posed by the Coding Contract.

View File

@@ -9,11 +9,11 @@ List all contract types.
**Signature:**
```typescript
getContractTypes(): `${CodingContractName}`[];
getContractTypes(): CodingContractName[];
```
**Returns:**
\`${[CodingContractName](./bitburner.codingcontractname.md)<!-- -->}\`\[\]
[CodingContractName](./bitburner.codingcontractname.md)<!-- -->\[\]
## Remarks

View File

@@ -2,44 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractName](./bitburner.codingcontractname.md)
## CodingContractName enum
## CodingContractName type
**Signature:**
```typescript
declare enum CodingContractName
type CodingContractName = _ValueOf<CodingContractNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AlgorithmicStockTraderI | <code>&quot;Algorithmic Stock Trader I&quot;</code> | |
| AlgorithmicStockTraderII | <code>&quot;Algorithmic Stock Trader II&quot;</code> | |
| AlgorithmicStockTraderIII | <code>&quot;Algorithmic Stock Trader III&quot;</code> | |
| AlgorithmicStockTraderIV | <code>&quot;Algorithmic Stock Trader IV&quot;</code> | |
| ArrayJumpingGame | <code>&quot;Array Jumping Game&quot;</code> | |
| ArrayJumpingGameII | <code>&quot;Array Jumping Game II&quot;</code> | |
| CompressionIIILZCompression | <code>&quot;Compression III: LZ Compression&quot;</code> | |
| CompressionIILZDecompression | <code>&quot;Compression II: LZ Decompression&quot;</code> | |
| CompressionIRLECompression | <code>&quot;Compression I: RLE Compression&quot;</code> | |
| EncryptionICaesarCipher | <code>&quot;Encryption I: Caesar Cipher&quot;</code> | |
| EncryptionIIVigenereCipher | <code>&quot;Encryption II: Vigenère Cipher&quot;</code> | |
| FindAllValidMathExpressions | <code>&quot;Find All Valid Math Expressions&quot;</code> | |
| FindLargestPrimeFactor | <code>&quot;Find Largest Prime Factor&quot;</code> | |
| GenerateIPAddresses | <code>&quot;Generate IP Addresses&quot;</code> | |
| HammingCodesEncodedBinaryToInteger | <code>&quot;HammingCodes: Encoded Binary to Integer&quot;</code> | |
| HammingCodesIntegerToEncodedBinary | <code>&quot;HammingCodes: Integer to Encoded Binary&quot;</code> | |
| MergeOverlappingIntervals | <code>&quot;Merge Overlapping Intervals&quot;</code> | |
| MinimumPathSumInATriangle | <code>&quot;Minimum Path Sum in a Triangle&quot;</code> | |
| Proper2ColoringOfAGraph | <code>&quot;Proper 2-Coloring of a Graph&quot;</code> | |
| SanitizeParenthesesInExpression | <code>&quot;Sanitize Parentheses in Expression&quot;</code> | |
| ShortestPathInAGrid | <code>&quot;Shortest Path in a Grid&quot;</code> | |
| SpiralizeMatrix | <code>&quot;Spiralize Matrix&quot;</code> | |
| SquareRoot | <code>&quot;Square Root&quot;</code> | |
| SubarrayWithMaximumSum | <code>&quot;Subarray with Maximum Sum&quot;</code> | |
| TotalWaysToSum | <code>&quot;Total Ways to Sum&quot;</code> | |
| TotalWaysToSumII | <code>&quot;Total Ways to Sum II&quot;</code> | |
| UniquePathsInAGridI | <code>&quot;Unique Paths in a Grid I&quot;</code> | |
| UniquePathsInAGridII | <code>&quot;Unique Paths in a Grid II&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md)

View File

@@ -0,0 +1,40 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md)
## CodingContractNameEnumType type
**Signature:**
```typescript
type CodingContractNameEnumType = {
FindLargestPrimeFactor: "Find Largest Prime Factor";
SubarrayWithMaximumSum: "Subarray with Maximum Sum";
TotalWaysToSum: "Total Ways to Sum";
TotalWaysToSumII: "Total Ways to Sum II";
SpiralizeMatrix: "Spiralize Matrix";
ArrayJumpingGame: "Array Jumping Game";
ArrayJumpingGameII: "Array Jumping Game II";
MergeOverlappingIntervals: "Merge Overlapping Intervals";
GenerateIPAddresses: "Generate IP Addresses";
AlgorithmicStockTraderI: "Algorithmic Stock Trader I";
AlgorithmicStockTraderII: "Algorithmic Stock Trader II";
AlgorithmicStockTraderIII: "Algorithmic Stock Trader III";
AlgorithmicStockTraderIV: "Algorithmic Stock Trader IV";
MinimumPathSumInATriangle: "Minimum Path Sum in a Triangle";
UniquePathsInAGridI: "Unique Paths in a Grid I";
UniquePathsInAGridII: "Unique Paths in a Grid II";
ShortestPathInAGrid: "Shortest Path in a Grid";
SanitizeParenthesesInExpression: "Sanitize Parentheses in Expression";
FindAllValidMathExpressions: "Find All Valid Math Expressions";
HammingCodesIntegerToEncodedBinary: "HammingCodes: Integer to Encoded Binary";
HammingCodesEncodedBinaryToInteger: "HammingCodes: Encoded Binary to Integer";
Proper2ColoringOfAGraph: "Proper 2-Coloring of a Graph";
CompressionIRLECompression: "Compression I: RLE Compression";
CompressionIILZDecompression: "Compression II: LZ Decompression";
CompressionIIILZCompression: "Compression III: LZ Compression";
EncryptionICaesarCipher: "Encryption I: Caesar Cipher";
EncryptionIIVigenereCipher: "Encryption II: Vigenère Cipher";
SquareRoot: "Square Root";
};
```

View File

@@ -8,35 +8,33 @@
```typescript
export type CodingContractSignatures = {
[CodingContractName.FindLargestPrimeFactor]: [number, number];
[CodingContractName.SubarrayWithMaximumSum]: [number[], number];
[CodingContractName.TotalWaysToSum]: [number, number];
[CodingContractName.TotalWaysToSumII]: [[number, number[]], number];
[CodingContractName.SpiralizeMatrix]: [number[][], number[]];
[CodingContractName.ArrayJumpingGame]: [number[], 1 | 0];
[CodingContractName.ArrayJumpingGameII]: [number[], number];
[CodingContractName.MergeOverlappingIntervals]: [[number, number][], [number, number][]];
[CodingContractName.GenerateIPAddresses]: [string, string[]];
[CodingContractName.AlgorithmicStockTraderI]: [number[], number];
[CodingContractName.AlgorithmicStockTraderII]: [number[], number];
[CodingContractName.AlgorithmicStockTraderIII]: [number[], number];
[CodingContractName.AlgorithmicStockTraderIV]: [[number, number[]], number];
[CodingContractName.MinimumPathSumInATriangle]: [number[][], number];
[CodingContractName.UniquePathsInAGridI]: [[number, number], number];
[CodingContractName.UniquePathsInAGridII]: [(1 | 0)[][], number];
[CodingContractName.ShortestPathInAGrid]: [(1 | 0)[][], string];
[CodingContractName.SanitizeParenthesesInExpression]: [string, string[]];
[CodingContractName.FindAllValidMathExpressions]: [[string, number], string[]];
[CodingContractName.HammingCodesIntegerToEncodedBinary]: [number, string];
[CodingContractName.HammingCodesEncodedBinaryToInteger]: [string, number];
[CodingContractName.Proper2ColoringOfAGraph]: [[number, [number, number][]], (1 | 0)[]];
[CodingContractName.CompressionIRLECompression]: [string, string];
[CodingContractName.CompressionIILZDecompression]: [string, string];
[CodingContractName.CompressionIIILZCompression]: [string, string];
[CodingContractName.EncryptionICaesarCipher]: [[string, number], string];
[CodingContractName.EncryptionIIVigenereCipher]: [[string, string], string];
[CodingContractName.SquareRoot]: [bigint, bigint, [string, string]];
"Find Largest Prime Factor": [number, number];
"Subarray with Maximum Sum": [number[], number];
"Total Ways to Sum": [number, number];
"Total Ways to Sum II": [[number, number[]], number];
"Spiralize Matrix": [number[][], number[]];
"Array Jumping Game": [number[], 1 | 0];
"Array Jumping Game II": [number[], number];
"Merge Overlapping Intervals": [[number, number][], [number, number][]];
"Generate IP Addresses": [string, string[]];
"Algorithmic Stock Trader I": [number[], number];
"Algorithmic Stock Trader II": [number[], number];
"Algorithmic Stock Trader III": [number[], number];
"Algorithmic Stock Trader IV": [[number, number[]], number];
"Minimum Path Sum in a Triangle": [number[][], number];
"Unique Paths in a Grid I": [[number, number], number];
"Unique Paths in a Grid II": [(1 | 0)[][], number];
"Shortest Path in a Grid": [(1 | 0)[][], string];
"Sanitize Parentheses in Expression": [string, string[]];
"Find All Valid Math Expressions": [[string, number], string[]];
"HammingCodes: Integer to Encoded Binary": [number, string];
"HammingCodes: Encoded Binary to Integer": [string, number];
"Proper 2-Coloring of a Graph": [[number, [number, number][]], (1 | 0)[]];
"Compression I: RLE Compression": [string, string];
"Compression II: LZ Decompression": [string, string];
"Compression III: LZ Compression": [string, string];
"Encryption I: Caesar Cipher": [[string, number], string];
"Encryption II: Vigenère Cipher": [[string, string], string];
"Square Root": [bigint, bigint, [string, string]];
};
```
**References:** [CodingContractName.FindLargestPrimeFactor](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SubarrayWithMaximumSum](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.TotalWaysToSum](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.TotalWaysToSumII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SpiralizeMatrix](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ArrayJumpingGame](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ArrayJumpingGameII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.MergeOverlappingIntervals](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.GenerateIPAddresses](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderI](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderIII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderIV](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.MinimumPathSumInATriangle](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.UniquePathsInAGridI](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.UniquePathsInAGridII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ShortestPathInAGrid](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SanitizeParenthesesInExpression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.FindAllValidMathExpressions](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.HammingCodesIntegerToEncodedBinary](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.HammingCodesEncodedBinaryToInteger](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.Proper2ColoringOfAGraph](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIRLECompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIILZDecompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIIILZCompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.EncryptionICaesarCipher](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.EncryptionIIVigenereCipher](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SquareRoot](./bitburner.codingcontractname.md)

View File

@@ -2,56 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyName](./bitburner.companyname.md)
## CompanyName enum
## CompanyName type
Names of all companies
**Signature:**
```typescript
declare enum CompanyName
type CompanyName = _ValueOf<CompanyNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AeroCorp | <code>&quot;AeroCorp&quot;</code> | |
| AlphaEnterprises | <code>&quot;Alpha Enterprises&quot;</code> | |
| BachmanAndAssociates | <code>&quot;Bachman &amp; Associates&quot;</code> | |
| BladeIndustries | <code>&quot;Blade Industries&quot;</code> | |
| CarmichaelSecurity | <code>&quot;Carmichael Security&quot;</code> | |
| CIA | <code>&quot;Central Intelligence Agency&quot;</code> | |
| ClarkeIncorporated | <code>&quot;Clarke Incorporated&quot;</code> | |
| CompuTek | <code>&quot;CompuTek&quot;</code> | |
| DefComm | <code>&quot;DefComm&quot;</code> | |
| DeltaOne | <code>&quot;DeltaOne&quot;</code> | |
| ECorp | <code>&quot;ECorp&quot;</code> | |
| FoodNStuff | <code>&quot;FoodNStuff&quot;</code> | |
| FourSigma | <code>&quot;Four Sigma&quot;</code> | |
| FulcrumTechnologies | <code>&quot;Fulcrum Technologies&quot;</code> | |
| GalacticCybersystems | <code>&quot;Galactic Cybersystems&quot;</code> | |
| GlobalPharmaceuticals | <code>&quot;Global Pharmaceuticals&quot;</code> | |
| HeliosLabs | <code>&quot;Helios Labs&quot;</code> | |
| IcarusMicrosystems | <code>&quot;Icarus Microsystems&quot;</code> | |
| JoesGuns | <code>&quot;Joe's Guns&quot;</code> | |
| KuaiGongInternational | <code>&quot;KuaiGong International&quot;</code> | |
| LexoCorp | <code>&quot;LexoCorp&quot;</code> | |
| MegaCorp | <code>&quot;MegaCorp&quot;</code> | |
| NetLinkTechnologies | <code>&quot;NetLink Technologies&quot;</code> | |
| NoodleBar | <code>&quot;Noodle Bar&quot;</code> | |
| NovaMedical | <code>&quot;Nova Medical&quot;</code> | |
| NSA | <code>&quot;National Security Agency&quot;</code> | |
| NWO | <code>&quot;NWO&quot;</code> | |
| OmegaSoftware | <code>&quot;Omega Software&quot;</code> | |
| OmniaCybersystems | <code>&quot;Omnia Cybersystems&quot;</code> | |
| OmniTekIncorporated | <code>&quot;OmniTek Incorporated&quot;</code> | |
| Police | <code>&quot;Aevum Police Headquarters&quot;</code> | |
| RhoConstruction | <code>&quot;Rho Construction&quot;</code> | |
| SolarisSpaceSystems | <code>&quot;Solaris Space Systems&quot;</code> | |
| StormTechnologies | <code>&quot;Storm Technologies&quot;</code> | |
| SysCoreSecurities | <code>&quot;SysCore Securities&quot;</code> | |
| UniversalEnergy | <code>&quot;Universal Energy&quot;</code> | |
| VitaLife | <code>&quot;VitaLife&quot;</code> | |
| WatchdogSecurity | <code>&quot;Watchdog Security&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [CompanyNameEnumType](./bitburner.companynameenumtype.md)

View File

@@ -0,0 +1,52 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyNameEnumType](./bitburner.companynameenumtype.md)
## CompanyNameEnumType type
Names of all companies
**Signature:**
```typescript
type CompanyNameEnumType = {
ECorp: "ECorp";
MegaCorp: "MegaCorp";
BachmanAndAssociates: "Bachman & Associates";
BladeIndustries: "Blade Industries";
NWO: "NWO";
ClarkeIncorporated: "Clarke Incorporated";
OmniTekIncorporated: "OmniTek Incorporated";
FourSigma: "Four Sigma";
KuaiGongInternational: "KuaiGong International";
FulcrumTechnologies: "Fulcrum Technologies";
StormTechnologies: "Storm Technologies";
DefComm: "DefComm";
HeliosLabs: "Helios Labs";
VitaLife: "VitaLife";
IcarusMicrosystems: "Icarus Microsystems";
UniversalEnergy: "Universal Energy";
GalacticCybersystems: "Galactic Cybersystems";
AeroCorp: "AeroCorp";
OmniaCybersystems: "Omnia Cybersystems";
SolarisSpaceSystems: "Solaris Space Systems";
DeltaOne: "DeltaOne";
GlobalPharmaceuticals: "Global Pharmaceuticals";
NovaMedical: "Nova Medical";
CIA: "Central Intelligence Agency";
NSA: "National Security Agency";
WatchdogSecurity: "Watchdog Security";
LexoCorp: "LexoCorp";
RhoConstruction: "Rho Construction";
AlphaEnterprises: "Alpha Enterprises";
Police: "Aevum Police Headquarters";
SysCoreSecurities: "SysCore Securities";
CompuTek: "CompuTek";
NetLinkTechnologies: "NetLink Technologies";
CarmichaelSecurity: "Carmichael Security";
FoodNStuff: "FoodNStuff";
JoesGuns: "Joe's Guns";
OmegaSoftware: "Omega Software";
NoodleBar: "Noodle Bar";
};
```

View File

@@ -9,7 +9,7 @@ Expand to a new city.
**Signature:**
```typescript
expandCity(divisionName: string, city: CityName | `${CityName}`): void;
expandCity(divisionName: string, city: CityName): void;
```
## Parameters
@@ -17,7 +17,7 @@ expandCity(divisionName: string, city: CityName | `${CityName}`): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
**Returns:**

View File

@@ -2,22 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md)
## CreatingCorporationCheckResult enum
## CreatingCorporationCheckResult type
**Signature:**
```typescript
declare enum CreatingCorporationCheckResult
type CreatingCorporationCheckResult = _ValueOf<CreatingCorporationCheckResultEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| CorporationExists | <code>&quot;CorporationExists&quot;</code> | |
| DisabledBySoftCap | <code>&quot;DisabledBySoftCap&quot;</code> | |
| NoSf3OrDisabled | <code>&quot;NoSf3OrDisabled&quot;</code> | |
| Success | <code>&quot;Success&quot;</code> | |
| UseSeedMoneyOutsideBN3 | <code>&quot;UseSeedMoneyOutsideBN3&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md)

View File

@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md)
## CreatingCorporationCheckResultEnumType type
**Signature:**
```typescript
type CreatingCorporationCheckResultEnumType = {
Success: "Success";
NoSf3OrDisabled: "NoSf3OrDisabled";
CorporationExists: "CorporationExists";
UseSeedMoneyOutsideBN3: "UseSeedMoneyOutsideBN3";
DisabledBySoftCap: "DisabledBySoftCap";
};
```

View File

@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeEnumType](./bitburner.crimeenumtype.md)
## CrimeEnumType type
**Signature:**
```typescript
type CrimeEnumType = {
shoplift: "Shoplift";
robStore: "Rob Store";
mug: "Mug";
larceny: "Larceny";
dealDrugs: "Deal Drugs";
bondForgery: "Bond Forgery";
traffickArms: "Traffick Arms";
homicide: "Homicide";
grandTheftAuto: "Grand Theft Auto";
kidnap: "Kidnap";
assassination: "Assassination";
heist: "Heist";
};
```

View File

@@ -2,29 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeType](./bitburner.crimetype.md)
## CrimeType enum
## CrimeType type
**Signature:**
```typescript
declare enum CrimeType
type CrimeType = _ValueOf<CrimeEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| assassination | <code>&quot;Assassination&quot;</code> | |
| bondForgery | <code>&quot;Bond Forgery&quot;</code> | |
| dealDrugs | <code>&quot;Deal Drugs&quot;</code> | |
| grandTheftAuto | <code>&quot;Grand Theft Auto&quot;</code> | |
| heist | <code>&quot;Heist&quot;</code> | |
| homicide | <code>&quot;Homicide&quot;</code> | |
| kidnap | <code>&quot;Kidnap&quot;</code> | |
| larceny | <code>&quot;Larceny&quot;</code> | |
| mug | <code>&quot;Mug&quot;</code> | |
| robStore | <code>&quot;Rob Store&quot;</code> | |
| shoplift | <code>&quot;Shoplift&quot;</code> | |
| traffickArms | <code>&quot;Traffick Arms&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [CrimeEnumType](./bitburner.crimeenumtype.md)

View File

@@ -2,54 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionName](./bitburner.factionname.md)
## FactionName enum
## FactionName type
Names of all factions.
Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.
**Signature:**
```typescript
declare enum FactionName
type FactionName = _ValueOf<FactionNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Aevum | <code>&quot;Aevum&quot;</code> | |
| BachmanAssociates | <code>&quot;Bachman &amp; Associates&quot;</code> | |
| BitRunners | <code>&quot;BitRunners&quot;</code> | |
| Bladeburners | <code>&quot;Bladeburners&quot;</code> | |
| BladeIndustries | <code>&quot;Blade Industries&quot;</code> | |
| Chongqing | <code>&quot;Chongqing&quot;</code> | |
| ChurchOfTheMachineGod | <code>&quot;Church of the Machine God&quot;</code> | |
| ClarkeIncorporated | <code>&quot;Clarke Incorporated&quot;</code> | |
| CyberSec | <code>&quot;CyberSec&quot;</code> | |
| Daedalus | <code>&quot;Daedalus&quot;</code> | |
| ECorp | <code>&quot;ECorp&quot;</code> | |
| FourSigma | <code>&quot;Four Sigma&quot;</code> | |
| FulcrumSecretTechnologies | <code>&quot;Fulcrum Secret Technologies&quot;</code> | |
| Illuminati | <code>&quot;Illuminati&quot;</code> | |
| Ishima | <code>&quot;Ishima&quot;</code> | |
| KuaiGongInternational | <code>&quot;KuaiGong International&quot;</code> | |
| MegaCorp | <code>&quot;MegaCorp&quot;</code> | |
| Netburners | <code>&quot;Netburners&quot;</code> | |
| NewTokyo | <code>&quot;New Tokyo&quot;</code> | |
| NiteSec | <code>&quot;NiteSec&quot;</code> | |
| NWO | <code>&quot;NWO&quot;</code> | |
| OmniTekIncorporated | <code>&quot;OmniTek Incorporated&quot;</code> | |
| Sector12 | <code>&quot;Sector-12&quot;</code> | |
| ShadowsOfAnarchy | <code>&quot;Shadows of Anarchy&quot;</code> | |
| Silhouette | <code>&quot;Silhouette&quot;</code> | |
| SlumSnakes | <code>&quot;Slum Snakes&quot;</code> | |
| SpeakersForTheDead | <code>&quot;Speakers for the Dead&quot;</code> | |
| Tetrads | <code>&quot;Tetrads&quot;</code> | |
| TheBlackHand | <code>&quot;The Black Hand&quot;</code> | |
| TheCovenant | <code>&quot;The Covenant&quot;</code> | |
| TheDarkArmy | <code>&quot;The Dark Army&quot;</code> | |
| TheSyndicate | <code>&quot;The Syndicate&quot;</code> | |
| TianDiHui | <code>&quot;Tian Di Hui&quot;</code> | |
| Volhaven | <code>&quot;Volhaven&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [FactionNameEnumType](./bitburner.factionnameenumtype.md)

View File

@@ -0,0 +1,50 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionNameEnumType](./bitburner.factionnameenumtype.md)
## FactionNameEnumType type
Names of all factions.
Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.
**Signature:**
```typescript
type FactionNameEnumType = {
Illuminati: "Illuminati";
Daedalus: "Daedalus";
TheCovenant: "The Covenant";
ECorp: "ECorp";
MegaCorp: "MegaCorp";
BachmanAssociates: "Bachman & Associates";
BladeIndustries: "Blade Industries";
NWO: "NWO";
ClarkeIncorporated: "Clarke Incorporated";
OmniTekIncorporated: "OmniTek Incorporated";
FourSigma: "Four Sigma";
KuaiGongInternational: "KuaiGong International";
FulcrumSecretTechnologies: "Fulcrum Secret Technologies";
BitRunners: "BitRunners";
TheBlackHand: "The Black Hand";
NiteSec: "NiteSec";
Aevum: "Aevum";
Chongqing: "Chongqing";
Ishima: "Ishima";
NewTokyo: "New Tokyo";
Sector12: "Sector-12";
Volhaven: "Volhaven";
SpeakersForTheDead: "Speakers for the Dead";
TheDarkArmy: "The Dark Army";
TheSyndicate: "The Syndicate";
Silhouette: "Silhouette";
Tetrads: "Tetrads";
SlumSnakes: "Slum Snakes";
Netburners: "Netburners";
TianDiHui: "Tian Di Hui";
CyberSec: "CyberSec";
Bladeburners: "Bladeburners";
ChurchOfTheMachineGod: "Church of the Machine God";
ShadowsOfAnarchy: "Shadows of Anarchy";
};
```

View File

@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkEnumType](./bitburner.factionworkenumtype.md)
## FactionWorkEnumType type
**Signature:**
```typescript
type FactionWorkEnumType = {
hacking: "hacking";
field: "field";
security: "security";
};
```

View File

@@ -2,20 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkType](./bitburner.factionworktype.md)
## FactionWorkType enum
## FactionWorkType type
**Signature:**
```typescript
declare enum FactionWorkType
type FactionWorkType = _ValueOf<FactionWorkEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| field | <code>&quot;field&quot;</code> | |
| hacking | <code>&quot;hacking&quot;</code> | |
| security | <code>&quot;security&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [FactionWorkEnumType](./bitburner.factionworkenumtype.md)

View File

@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GymEnumType](./bitburner.gymenumtype.md)
## GymEnumType type
**Signature:**
```typescript
type GymEnumType = {
strength: "str";
defense: "def";
dexterity: "dex";
agility: "agi";
};
```

View File

@@ -2,23 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GymLocationName](./bitburner.gymlocationname.md)
## GymLocationName enum
## GymLocationName type
Locations of gym
**Signature:**
```typescript
declare enum GymLocationName
type GymLocationName = _ValueOf<GymLocationNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AevumCrushFitnessGym | <code>LocationName.AevumCrushFitnessGym</code> | |
| AevumSnapFitnessGym | <code>LocationName.AevumSnapFitnessGym</code> | |
| Sector12IronGym | <code>LocationName.Sector12IronGym</code> | |
| Sector12PowerhouseGym | <code>LocationName.Sector12PowerhouseGym</code> | |
| VolhavenMilleniumFitnessGym | <code>LocationName.VolhavenMilleniumFitnessGym</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md)

View File

@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md)
## GymLocationNameEnumType type
Locations of gym
**Signature:**
```typescript
type GymLocationNameEnumType = {
AevumCrushFitnessGym: LocationNameEnumType["AevumCrushFitnessGym"];
AevumSnapFitnessGym: LocationNameEnumType["AevumSnapFitnessGym"];
Sector12IronGym: LocationNameEnumType["Sector12IronGym"];
Sector12PowerhouseGym: LocationNameEnumType["Sector12PowerhouseGym"];
VolhavenMilleniumFitnessGym: LocationNameEnumType["VolhavenMilleniumFitnessGym"];
};
```
**References:** [LocationNameEnumType](./bitburner.locationnameenumtype.md)

View File

@@ -2,21 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GymType](./bitburner.gymtype.md)
## GymType enum
## GymType type
**Signature:**
```typescript
declare enum GymType
type GymType = _ValueOf<GymEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agility | <code>&quot;agi&quot;</code> | |
| defense | <code>&quot;def&quot;</code> | |
| dexterity | <code>&quot;dex&quot;</code> | |
| strength | <code>&quot;str&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [GymEnumType](./bitburner.gymenumtype.md)

View File

@@ -9,14 +9,14 @@ Get all infiltrations with difficulty, location and rewards.
**Signature:**
```typescript
getInfiltration(location: LocationName | `${LocationName}`): InfiltrationLocation;
getInfiltration(location: LocationName): InfiltrationLocation;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| location | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)<!-- -->}\` | |
| location | [LocationName](./bitburner.locationname.md) | |
**Returns:**

View File

@@ -2,30 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [JobField](./bitburner.jobfield.md)
## JobField enum
## JobField type
**Signature:**
```typescript
declare enum JobField
type JobField = _ValueOf<JobFieldEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agent | <code>&quot;Agent&quot;</code> | |
| business | <code>&quot;Business&quot;</code> | |
| businessConsultant | <code>&quot;Business Consultant&quot;</code> | |
| employee | <code>&quot;Employee&quot;</code> | |
| it | <code>&quot;IT&quot;</code> | |
| networkEngineer | <code>&quot;Network Engineer&quot;</code> | |
| partTimeEmployee | <code>&quot;Part-time Employee&quot;</code> | |
| partTimeWaiter | <code>&quot;Part-time Waiter&quot;</code> | |
| security | <code>&quot;Security&quot;</code> | |
| securityEngineer | <code>&quot;Security Engineer&quot;</code> | |
| software | <code>&quot;Software&quot;</code> | |
| softwareConsultant | <code>&quot;Software Consultant&quot;</code> | |
| waiter | <code>&quot;Waiter&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [JobFieldEnumType](./bitburner.jobfieldenumtype.md)

View File

@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [JobFieldEnumType](./bitburner.jobfieldenumtype.md)
## JobFieldEnumType type
**Signature:**
```typescript
type JobFieldEnumType = {
software: "Software";
softwareConsultant: "Software Consultant";
it: "IT";
securityEngineer: "Security Engineer";
networkEngineer: "Network Engineer";
business: "Business";
businessConsultant: "Business Consultant";
security: "Security";
agent: "Agent";
employee: "Employee";
partTimeEmployee: "Part-time Employee";
waiter: "Waiter";
partTimeWaiter: "Part-time Waiter";
};
```

View File

@@ -2,53 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [JobName](./bitburner.jobname.md)
## JobName enum
## JobName type
**Signature:**
```typescript
declare enum JobName
type JobName = _ValueOf<JobNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agent0 | <code>&quot;Field Agent&quot;</code> | |
| agent1 | <code>&quot;Secret Agent&quot;</code> | |
| agent2 | <code>&quot;Special Operative&quot;</code> | |
| business0 | <code>&quot;Business Intern&quot;</code> | |
| business1 | <code>&quot;Business Analyst&quot;</code> | |
| business2 | <code>&quot;Business Manager&quot;</code> | |
| business3 | <code>&quot;Operations Manager&quot;</code> | |
| business4 | <code>&quot;Chief Financial Officer&quot;</code> | |
| business5 | <code>&quot;Chief Executive Officer&quot;</code> | |
| businessConsult0 | <code>&quot;Business Consultant&quot;</code> | |
| businessConsult1 | <code>&quot;Senior Business Consultant&quot;</code> | |
| employee | <code>&quot;Employee&quot;</code> | |
| employeePT | <code>&quot;Part-time Employee&quot;</code> | |
| IT0 | <code>&quot;IT Intern&quot;</code> | |
| IT1 | <code>&quot;IT Analyst&quot;</code> | |
| IT2 | <code>&quot;IT Manager&quot;</code> | |
| IT3 | <code>&quot;Systems Administrator&quot;</code> | |
| networkEng0 | <code>&quot;Network Engineer&quot;</code> | |
| networkEng1 | <code>&quot;Network Administrator&quot;</code> | |
| security0 | <code>&quot;Security Guard&quot;</code> | |
| security1 | <code>&quot;Security Officer&quot;</code> | |
| security2 | <code>&quot;Security Supervisor&quot;</code> | |
| security3 | <code>&quot;Head of Security&quot;</code> | |
| securityEng | <code>&quot;Security Engineer&quot;</code> | |
| software0 | <code>&quot;Software Engineering Intern&quot;</code> | |
| software1 | <code>&quot;Junior Software Engineer&quot;</code> | |
| software2 | <code>&quot;Senior Software Engineer&quot;</code> | |
| software3 | <code>&quot;Lead Software Developer&quot;</code> | |
| software4 | <code>&quot;Head of Software&quot;</code> | |
| software5 | <code>&quot;Head of Engineering&quot;</code> | |
| software6 | <code>&quot;Vice President of Technology&quot;</code> | |
| software7 | <code>&quot;Chief Technology Officer&quot;</code> | |
| softwareConsult0 | <code>&quot;Software Consultant&quot;</code> | |
| softwareConsult1 | <code>&quot;Senior Software Consultant&quot;</code> | |
| waiter | <code>&quot;Waiter&quot;</code> | |
| waiterPT | <code>&quot;Part-time Waiter&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [JobNameEnumType](./bitburner.jobnameenumtype.md)

View File

@@ -0,0 +1,49 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [JobNameEnumType](./bitburner.jobnameenumtype.md)
## JobNameEnumType type
**Signature:**
```typescript
type JobNameEnumType = {
software0: "Software Engineering Intern";
software1: "Junior Software Engineer";
software2: "Senior Software Engineer";
software3: "Lead Software Developer";
software4: "Head of Software";
software5: "Head of Engineering";
software6: "Vice President of Technology";
software7: "Chief Technology Officer";
IT0: "IT Intern";
IT1: "IT Analyst";
IT2: "IT Manager";
IT3: "Systems Administrator";
securityEng: "Security Engineer";
networkEng0: "Network Engineer";
networkEng1: "Network Administrator";
business0: "Business Intern";
business1: "Business Analyst";
business2: "Business Manager";
business3: "Operations Manager";
business4: "Chief Financial Officer";
business5: "Chief Executive Officer";
security0: "Security Guard";
security1: "Security Officer";
security2: "Security Supervisor";
security3: "Head of Security";
agent0: "Field Agent";
agent1: "Secret Agent";
agent2: "Special Operative";
waiter: "Waiter";
employee: "Employee";
softwareConsult0: "Software Consultant";
softwareConsult1: "Senior Software Consultant";
businessConsult0: "Business Consultant";
businessConsult1: "Senior Business Consultant";
waiterPT: "Part-time Waiter";
employeePT: "Part-time Employee";
};
```

View File

@@ -2,74 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [LocationName](./bitburner.locationname.md)
## LocationName enum
## LocationName type
Names of all locations
**Signature:**
```typescript
declare enum LocationName
type LocationName = _ValueOf<LocationNameEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AevumAeroCorp | <code>&quot;AeroCorp&quot;</code> | |
| AevumBachmanAndAssociates | <code>&quot;Bachman &amp; Associates&quot;</code> | |
| AevumCasino | <code>&quot;Iker Molina Casino&quot;</code> | |
| AevumClarkeIncorporated | <code>&quot;Clarke Incorporated&quot;</code> | |
| AevumCrushFitnessGym | <code>&quot;Crush Fitness Gym&quot;</code> | |
| AevumECorp | <code>&quot;ECorp&quot;</code> | |
| AevumFulcrumTechnologies | <code>&quot;Fulcrum Technologies&quot;</code> | |
| AevumGalacticCybersystems | <code>&quot;Galactic Cybersystems&quot;</code> | |
| AevumNetLinkTechnologies | <code>&quot;NetLink Technologies&quot;</code> | |
| AevumPolice | <code>&quot;Aevum Police Headquarters&quot;</code> | |
| AevumRhoConstruction | <code>&quot;Rho Construction&quot;</code> | |
| AevumSnapFitnessGym | <code>&quot;Snap Fitness Gym&quot;</code> | |
| AevumSummitUniversity | <code>&quot;Summit University&quot;</code> | |
| AevumWatchdogSecurity | <code>&quot;Watchdog Security&quot;</code> | |
| ChongqingChurchOfTheMachineGod | <code>&quot;Church of the Machine God&quot;</code> | |
| ChongqingKuaiGongInternational | <code>&quot;KuaiGong International&quot;</code> | |
| ChongqingSolarisSpaceSystems | <code>&quot;Solaris Space Systems&quot;</code> | |
| Hospital | <code>&quot;Hospital&quot;</code> | |
| IshimaGlitch | <code>&quot;0x6C1&quot;</code> | |
| IshimaNovaMedical | <code>&quot;Nova Medical&quot;</code> | |
| IshimaOmegaSoftware | <code>&quot;Omega Software&quot;</code> | |
| IshimaStormTechnologies | <code>&quot;Storm Technologies&quot;</code> | |
| NewTokyoArcade | <code>&quot;Arcade&quot;</code> | |
| NewTokyoDefComm | <code>&quot;DefComm&quot;</code> | |
| NewTokyoGlobalPharmaceuticals | <code>&quot;Global Pharmaceuticals&quot;</code> | |
| NewTokyoNoodleBar | <code>&quot;Noodle Bar&quot;</code> | |
| NewTokyoVitaLife | <code>&quot;VitaLife&quot;</code> | |
| Sector12AlphaEnterprises | <code>&quot;Alpha Enterprises&quot;</code> | |
| Sector12BladeIndustries | <code>&quot;Blade Industries&quot;</code> | |
| Sector12CarmichaelSecurity | <code>&quot;Carmichael Security&quot;</code> | |
| Sector12CIA | <code>&quot;Central Intelligence Agency&quot;</code> | |
| Sector12CityHall | <code>&quot;Sector-12 City Hall&quot;</code> | |
| Sector12DeltaOne | <code>&quot;DeltaOne&quot;</code> | |
| Sector12FoodNStuff | <code>&quot;FoodNStuff&quot;</code> | |
| Sector12FourSigma | <code>&quot;Four Sigma&quot;</code> | |
| Sector12IcarusMicrosystems | <code>&quot;Icarus Microsystems&quot;</code> | |
| Sector12IronGym | <code>&quot;Iron Gym&quot;</code> | |
| Sector12JoesGuns | <code>&quot;Joe's Guns&quot;</code> | |
| Sector12MegaCorp | <code>&quot;MegaCorp&quot;</code> | |
| Sector12NSA | <code>&quot;National Security Agency&quot;</code> | |
| Sector12PowerhouseGym | <code>&quot;Powerhouse Gym&quot;</code> | |
| Sector12RothmanUniversity | <code>&quot;Rothman University&quot;</code> | |
| Sector12UniversalEnergy | <code>&quot;Universal Energy&quot;</code> | |
| Slums | <code>&quot;The Slums&quot;</code> | |
| TravelAgency | <code>&quot;Travel Agency&quot;</code> | |
| Void | <code>&quot;The Void&quot;</code> | |
| VolhavenCompuTek | <code>&quot;CompuTek&quot;</code> | |
| VolhavenHeliosLabs | <code>&quot;Helios Labs&quot;</code> | |
| VolhavenLexoCorp | <code>&quot;LexoCorp&quot;</code> | |
| VolhavenMilleniumFitnessGym | <code>&quot;Millenium Fitness Gym&quot;</code> | |
| VolhavenNWO | <code>&quot;NWO&quot;</code> | |
| VolhavenOmniaCybersystems | <code>&quot;Omnia Cybersystems&quot;</code> | |
| VolhavenOmniTekIncorporated | <code>&quot;OmniTek Incorporated&quot;</code> | |
| VolhavenSysCoreSecurities | <code>&quot;SysCore Securities&quot;</code> | |
| VolhavenZBInstituteOfTechnology | <code>&quot;ZB Institute of Technology&quot;</code> | |
| WorldStockExchange | <code>&quot;World Stock Exchange&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [LocationNameEnumType](./bitburner.locationnameenumtype.md)

View File

@@ -0,0 +1,77 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [LocationNameEnumType](./bitburner.locationnameenumtype.md)
## LocationNameEnumType type
Names of all locations
**Signature:**
```typescript
type LocationNameEnumType = {
AevumAeroCorp: "AeroCorp";
AevumBachmanAndAssociates: "Bachman & Associates";
AevumClarkeIncorporated: "Clarke Incorporated";
AevumCrushFitnessGym: "Crush Fitness Gym";
AevumECorp: "ECorp";
AevumFulcrumTechnologies: "Fulcrum Technologies";
AevumGalacticCybersystems: "Galactic Cybersystems";
AevumNetLinkTechnologies: "NetLink Technologies";
AevumPolice: "Aevum Police Headquarters";
AevumRhoConstruction: "Rho Construction";
AevumSnapFitnessGym: "Snap Fitness Gym";
AevumSummitUniversity: "Summit University";
AevumWatchdogSecurity: "Watchdog Security";
AevumCasino: "Iker Molina Casino";
ChongqingKuaiGongInternational: "KuaiGong International";
ChongqingSolarisSpaceSystems: "Solaris Space Systems";
ChongqingChurchOfTheMachineGod: "Church of the Machine God";
Sector12AlphaEnterprises: "Alpha Enterprises";
Sector12BladeIndustries: "Blade Industries";
Sector12CIA: "Central Intelligence Agency";
Sector12CarmichaelSecurity: "Carmichael Security";
Sector12CityHall: "Sector-12 City Hall";
Sector12DeltaOne: "DeltaOne";
Sector12FoodNStuff: "FoodNStuff";
Sector12FourSigma: "Four Sigma";
Sector12IcarusMicrosystems: "Icarus Microsystems";
Sector12IronGym: "Iron Gym";
Sector12JoesGuns: "Joe's Guns";
Sector12MegaCorp: "MegaCorp";
Sector12NSA: "National Security Agency";
Sector12PowerhouseGym: "Powerhouse Gym";
Sector12RothmanUniversity: "Rothman University";
Sector12UniversalEnergy: "Universal Energy";
NewTokyoDefComm: "DefComm";
NewTokyoGlobalPharmaceuticals: "Global Pharmaceuticals";
NewTokyoNoodleBar: "Noodle Bar";
NewTokyoVitaLife: "VitaLife";
NewTokyoArcade: "Arcade";
IshimaNovaMedical: "Nova Medical";
IshimaOmegaSoftware: "Omega Software";
IshimaStormTechnologies: "Storm Technologies";
IshimaGlitch: "0x6C1";
VolhavenCompuTek: "CompuTek";
VolhavenHeliosLabs: "Helios Labs";
VolhavenLexoCorp: "LexoCorp";
VolhavenMilleniumFitnessGym: "Millenium Fitness Gym";
VolhavenNWO: "NWO";
VolhavenOmniTekIncorporated: "OmniTek Incorporated";
VolhavenOmniaCybersystems: "Omnia Cybersystems";
VolhavenSysCoreSecurities: "SysCore Securities";
VolhavenZBInstituteOfTechnology: "ZB Institute of Technology";
Hospital: "Hospital";
Slums: "The Slums";
TravelAgency: "Travel Agency";
WorldStockExchange: "World Stock Exchange";
Void: "The Void";
};
```

View File

@@ -4,35 +4,6 @@
## bitburner package
## Enumerations
| Enumeration | Description |
| --- | --- |
| [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Action types of Bladeburner |
| [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Black Operation names of Bladeburner |
| [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | Contract names of Bladeburner |
| [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | General action names of Bladeburner |
| [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | Operation names of Bladeburner |
| [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill names type of Bladeburner |
| [CityName](./bitburner.cityname.md) | Names of all cities |
| [CodingContractName](./bitburner.codingcontractname.md) | |
| [CompanyName](./bitburner.companyname.md) | Names of all companies |
| [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) | |
| [CrimeType](./bitburner.crimetype.md) | |
| [FactionName](./bitburner.factionname.md) | <p>Names of all factions.</p><p>Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.</p> |
| [FactionWorkType](./bitburner.factionworktype.md) | |
| [GymLocationName](./bitburner.gymlocationname.md) | Locations of gym |
| [GymType](./bitburner.gymtype.md) | |
| [JobField](./bitburner.jobfield.md) | |
| [JobName](./bitburner.jobname.md) | |
| [LocationName](./bitburner.locationname.md) | Names of all locations |
| [OrderType](./bitburner.ordertype.md) | |
| [PositionType](./bitburner.positiontype.md) | |
| [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | These special Bladeburner action types are only for Sleeve |
| [ToastVariant](./bitburner.toastvariant.md) | |
| [UniversityClassType](./bitburner.universityclasstype.md) | |
| [UniversityLocationName](./bitburner.universitylocationname.md) | Locations of university |
## Interfaces
| Interface | Description |
@@ -166,10 +137,29 @@
| Type Alias | Description |
| --- | --- |
| [\_ValueOf](./bitburner._valueof.md) | |
| [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) | Action types of Bladeburner |
| [BladeburnerActionName](./bitburner.bladeburneractionname.md) | |
| [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | |
| [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | |
| [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | |
| [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) | Black Operation names of Bladeburner |
| [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | |
| [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) | Contract names of Bladeburner |
| [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | |
| [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) | General action names of Bladeburner |
| [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | |
| [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) | Operation names of Bladeburner |
| [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | |
| [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) | Skill names type of Bladeburner |
| [CityName](./bitburner.cityname.md) | |
| [CityNameEnumType](./bitburner.citynameenumtype.md) | Names of all cities |
| [CodingContractName](./bitburner.codingcontractname.md) | |
| [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) | |
| [CodingContractObject](./bitburner.codingcontractobject.md) | |
| [CodingContractSignatures](./bitburner.codingcontractsignatures.md) | |
| [CompanyName](./bitburner.companyname.md) | |
| [CompanyNameEnumType](./bitburner.companynameenumtype.md) | Names of all companies |
| [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | |
| [CorpIndustryName](./bitburner.corpindustryname.md) | |
| [CorpMaterialName](./bitburner.corpmaterialname.md) | |
@@ -178,10 +168,32 @@
| [CorpStateName](./bitburner.corpstatename.md) | |
| [CorpUnlockName](./bitburner.corpunlockname.md) | |
| [CorpUpgradeName](./bitburner.corpupgradename.md) | |
| [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) | |
| [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) | |
| [CrimeEnumType](./bitburner.crimeenumtype.md) | |
| [CrimeType](./bitburner.crimetype.md) | |
| [FactionName](./bitburner.factionname.md) | |
| [FactionNameEnumType](./bitburner.factionnameenumtype.md) | <p>Names of all factions.</p><p>Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.</p> |
| [FactionWorkEnumType](./bitburner.factionworkenumtype.md) | |
| [FactionWorkType](./bitburner.factionworktype.md) | |
| [FilenameOrPID](./bitburner.filenameorpid.md) | |
| [GoOpponent](./bitburner.goopponent.md) | |
| [GymEnumType](./bitburner.gymenumtype.md) | |
| [GymLocationName](./bitburner.gymlocationname.md) | |
| [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) | Locations of gym |
| [GymType](./bitburner.gymtype.md) | |
| [JobField](./bitburner.jobfield.md) | |
| [JobFieldEnumType](./bitburner.jobfieldenumtype.md) | |
| [JobName](./bitburner.jobname.md) | |
| [JobNameEnumType](./bitburner.jobnameenumtype.md) | |
| [LocationName](./bitburner.locationname.md) | |
| [LocationNameEnumType](./bitburner.locationnameenumtype.md) | Names of all locations |
| [NSEnums](./bitburner.nsenums.md) | |
| [OrderEnumType](./bitburner.orderenumtype.md) | |
| [OrderType](./bitburner.ordertype.md) | |
| [PlayerRequirement](./bitburner.playerrequirement.md) | Structured interface to requirements for joining a faction or company. For fields with numerical value &gt; 0, the player must have at least this value. For fields with numerical value &lt;<!-- -->= 0, the player must have at most this value. For "not", the sub-condition must be failed instead of passed. For "someCondition", at least one sub-condition must be passed. |
| [PositionEnumType](./bitburner.positionenumtype.md) | |
| [PositionType](./bitburner.positiontype.md) | |
| [ReactNode](./bitburner.reactnode.md) | <p>A stand-in for the real React.ReactNode. A [ReactElement](./bitburner.reactelement.md) is rendered dynamically with React. number and string are displayed directly. boolean, null, and undefined are ignored and not rendered. An array of ReactNodes will display all members of that array sequentially.</p><p>Use React.createElement to make the ReactElement type, see [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation.</p> |
| [ScriptArg](./bitburner.scriptarg.md) | |
| [SimpleOpponentStats](./bitburner.simpleopponentstats.md) | |
@@ -195,5 +207,13 @@
| [SleeveSupportTask](./bitburner.sleevesupporttask.md) | |
| [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) | |
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
| [SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) | These special Bladeburner action types are only for Sleeve |
| [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | |
| [Task](./bitburner.task.md) | Task |
| [ToastVariant](./bitburner.toastvariant.md) | |
| [ToastVariantEnumType](./bitburner.toastvariantenumtype.md) | |
| [UniversityClassEnumType](./bitburner.universityclassenumtype.md) | |
| [UniversityClassType](./bitburner.universityclasstype.md) | |
| [UniversityLocationName](./bitburner.universitylocationname.md) | |
| [UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) | Locations of university |

View File

@@ -9,7 +9,7 @@ Queue a toast (bottom-right notification).
**Signature:**
```typescript
toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void;
toast(msg: string, variant?: ToastVariant, duration?: number | null): void;
```
## Parameters
@@ -17,7 +17,7 @@ toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number
| Parameter | Type | Description |
| --- | --- | --- |
| msg | string | Message in the toast. |
| variant | [ToastVariant](./bitburner.toastvariant.md) \| \`${[ToastVariant](./bitburner.toastvariant.md)<!-- -->}\` | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. |
| variant | [ToastVariant](./bitburner.toastvariant.md) | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. |
| duration | number \| null | _(Optional)_ Duration of toast in ms. Can also be <code>null</code> to create a persistent toast. Defaults to 2000. |
**Returns:**

View File

@@ -8,20 +8,20 @@
**Signature:**
```typescript
export type NSEnums = {
CityName: typeof CityName;
CrimeType: typeof CrimeType;
FactionWorkType: typeof FactionWorkType;
GymType: typeof GymType;
JobName: typeof JobName;
JobField: typeof JobField;
LocationName: typeof LocationName;
ToastVariant: typeof ToastVariant;
UniversityClassType: typeof UniversityClassType;
CompanyName: typeof CompanyName;
FactionName: typeof FactionName;
CodingContractName: typeof CodingContractName;
type NSEnums = {
CityName: CityNameEnumType;
CrimeType: CrimeEnumType;
FactionWorkType: FactionWorkEnumType;
GymType: GymEnumType;
JobName: JobNameEnumType;
JobField: JobFieldEnumType;
LocationName: LocationNameEnumType;
ToastVariant: ToastVariantEnumType;
UniversityClassType: UniversityClassEnumType;
CompanyName: CompanyNameEnumType;
FactionName: FactionNameEnumType;
CodingContractName: CodingContractNameEnumType;
};
```
**References:** [CityName](./bitburner.cityname.md)<!-- -->, [CrimeType](./bitburner.crimetype.md)<!-- -->, [FactionWorkType](./bitburner.factionworktype.md)<!-- -->, [GymType](./bitburner.gymtype.md)<!-- -->, [JobName](./bitburner.jobname.md)<!-- -->, [JobField](./bitburner.jobfield.md)<!-- -->, [LocationName](./bitburner.locationname.md)<!-- -->, [ToastVariant](./bitburner.toastvariant.md)<!-- -->, [UniversityClassType](./bitburner.universityclasstype.md)<!-- -->, [CompanyName](./bitburner.companyname.md)<!-- -->, [FactionName](./bitburner.factionname.md)<!-- -->, [CodingContractName](./bitburner.codingcontractname.md)
**References:** [CityNameEnumType](./bitburner.citynameenumtype.md)<!-- -->, [CrimeEnumType](./bitburner.crimeenumtype.md)<!-- -->, [FactionWorkEnumType](./bitburner.factionworkenumtype.md)<!-- -->, [GymEnumType](./bitburner.gymenumtype.md)<!-- -->, [JobNameEnumType](./bitburner.jobnameenumtype.md)<!-- -->, [JobFieldEnumType](./bitburner.jobfieldenumtype.md)<!-- -->, [LocationNameEnumType](./bitburner.locationnameenumtype.md)<!-- -->, [ToastVariantEnumType](./bitburner.toastvariantenumtype.md)<!-- -->, [UniversityClassEnumType](./bitburner.universityclassenumtype.md)<!-- -->, [CompanyNameEnumType](./bitburner.companynameenumtype.md)<!-- -->, [FactionNameEnumType](./bitburner.factionnameenumtype.md)<!-- -->, [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md)

View File

@@ -9,7 +9,7 @@ Buy tea for your employees.
**Signature:**
```typescript
buyTea(divisionName: string, city: CityName | `${CityName}`): boolean;
buyTea(divisionName: string, city: CityName): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ buyTea(divisionName: string, city: CityName | `${CityName}`): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
**Returns:**

View File

@@ -9,7 +9,7 @@ Get data about an office.
**Signature:**
```typescript
getOffice(divisionName: string, city: CityName | `${CityName}`): Office;
getOffice(divisionName: string, city: CityName): Office;
```
## Parameters
@@ -17,7 +17,7 @@ getOffice(divisionName: string, city: CityName | `${CityName}`): Office;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
**Returns:**

View File

@@ -9,7 +9,7 @@ Get the cost to upgrade an office.
**Signature:**
```typescript
getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, size: number): number;
getOfficeSizeUpgradeCost(divisionName: string, city: CityName, size: number): number;
```
## Parameters
@@ -17,7 +17,7 @@ getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, s
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
| size | number | Amount of positions to open |
**Returns:**

View File

@@ -9,7 +9,7 @@ Hire an employee.
**Signature:**
```typescript
hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean;
hireEmployee(divisionName: string, city: CityName, employeePosition?: CorpEmployeePosition): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosit
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
| employeePosition | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | _(Optional)_ Position to place into. Defaults to "Unassigned". |
**Returns:**

View File

@@ -9,7 +9,7 @@ Set the job assignment for a job.
**Signature:**
```typescript
setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean;
setAutoJobAssignment(divisionName: string, city: CityName, job: string, amount: number): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job:
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
| job | string | Name of the job |
| amount | number | Number of employees to assign to that job |

View File

@@ -9,7 +9,7 @@ Throw a party for your employees.
**Signature:**
```typescript
throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number;
throwParty(divisionName: string, city: CityName, costPerEmployee: number): number;
```
## Parameters
@@ -17,7 +17,7 @@ throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
| costPerEmployee | number | Amount to spend per employee. |
**Returns:**

View File

@@ -9,7 +9,7 @@ Upgrade office size.
**Signature:**
```typescript
upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void;
upgradeOfficeSize(divisionName: string, city: CityName, size: number): void;
```
## Parameters
@@ -17,7 +17,7 @@ upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: nu
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| city | [CityName](./bitburner.cityname.md) | Name of the city |
| size | number | Amount of positions to open |
**Returns:**

View File

@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OrderEnumType](./bitburner.orderenumtype.md)
## OrderEnumType type
**Signature:**
```typescript
type OrderEnumType = {
LimitBuy: "Limit Buy Order";
LimitSell: "Limit Sell Order";
StopBuy: "Stop Buy Order";
StopSell: "Stop Sell Order";
};
```

View File

@@ -2,21 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OrderType](./bitburner.ordertype.md)
## OrderType enum
## OrderType type
**Signature:**
```typescript
declare enum OrderType
type OrderType = _ValueOf<OrderEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| LimitBuy | <code>&quot;Limit Buy Order&quot;</code> | |
| LimitSell | <code>&quot;Limit Sell Order&quot;</code> | |
| StopBuy | <code>&quot;Stop Buy Order&quot;</code> | |
| StopSell | <code>&quot;Stop Sell Order&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [OrderEnumType](./bitburner.orderenumtype.md)

View File

@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [PositionEnumType](./bitburner.positionenumtype.md)
## PositionEnumType type
**Signature:**
```typescript
type PositionEnumType = {
Long: "L";
Short: "S";
};
```

View File

@@ -2,19 +2,13 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [PositionType](./bitburner.positiontype.md)
## PositionType enum
## PositionType type
**Signature:**
```typescript
declare enum PositionType
type PositionType = _ValueOf<PositionEnumType>;
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Long | <code>&quot;L&quot;</code> | |
| Short | <code>&quot;S&quot;</code> | |
**References:** [\_ValueOf](./bitburner._valueof.md)<!-- -->, [PositionEnumType](./bitburner.positionenumtype.md)

View File

@@ -9,15 +9,15 @@ Apply for a job at a company.
**Signature:**
```typescript
applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `${JobField}`): JobName | null;
applyToCompany(companyName: CompanyName, field: JobField): JobName | null;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of company to apply to. |
| field | [JobField](./bitburner.jobfield.md) \| \`${[JobField](./bitburner.jobfield.md)<!-- -->}\` | Field to which you want to apply. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to apply to. |
| field | [JobField](./bitburner.jobfield.md) | Field to which you want to apply. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Commit a crime.
**Signature:**
```typescript
commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number;
commitCrime(crime: CrimeType, focus?: boolean): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | Name of crime to attempt. |
| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime to attempt. |
| focus | boolean | _(Optional)_ Acquire player focus on this crime. Optional. Defaults to true. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get company favor.
**Signature:**
```typescript
getCompanyFavor(companyName: CompanyName | `${CompanyName}`): number;
getCompanyFavor(companyName: CompanyName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get company favor gain.
**Signature:**
```typescript
getCompanyFavorGain(companyName: CompanyName | `${CompanyName}`): number;
getCompanyFavorGain(companyName: CompanyName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get Requirements for Company Position.
**Signature:**
```typescript
getCompanyPositionInfo(
companyName: CompanyName | `${CompanyName}`,
positionName: JobName | `${JobName}`,
): CompanyPositionInfo;
getCompanyPositionInfo(companyName: CompanyName, positionName: JobName): CompanyPositionInfo;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of company to get the requirements for. Must be an exact match. |
| positionName | [JobName](./bitburner.jobname.md) \| \`${[JobName](./bitburner.jobname.md)<!-- -->}\` | Name of position to get the requirements for. Must be an exact match. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to get the requirements for. Must be an exact match. |
| positionName | [JobName](./bitburner.jobname.md) | Name of position to get the requirements for. Must be an exact match. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get List of Company Positions.
**Signature:**
```typescript
getCompanyPositions(companyName: CompanyName | `${CompanyName}`): JobName[];
getCompanyPositions(companyName: CompanyName): JobName[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of company to get the position list for. Must be an exact match. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to get the position list for. Must be an exact match. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get company reputation.
**Signature:**
```typescript
getCompanyRep(companyName: CompanyName | `${CompanyName}`): number;
getCompanyRep(companyName: CompanyName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get chance to successfully commit a crime.
**Signature:**
```typescript
getCrimeChance(crime: CrimeType | `${CrimeType}`): number;
getCrimeChance(crime: CrimeType): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | Name of crime. |
| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Get stats related to a crime.
**Signature:**
```typescript
getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats;
getCrimeStats(crime: CrimeType): CrimeStats;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | Name of crime. |
| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Go to a location.
**Signature:**
```typescript
goToLocation(locationName: LocationName | `${LocationName}`): boolean;
goToLocation(locationName: LocationName): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| locationName | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)<!-- -->}\` | Name of the location. |
| locationName | [LocationName](./bitburner.locationname.md) | Name of the location. |
**Returns:**

View File

@@ -9,15 +9,15 @@ Workout at the gym.
**Signature:**
```typescript
gymWorkout(gymName: GymLocationName | `${GymLocationName}`, stat: GymType | `${GymType}`, focus?: boolean): boolean;
gymWorkout(gymName: GymLocationName, stat: GymType, focus?: boolean): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| gymName | [GymLocationName](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)<!-- -->}\` | Name of gym. You must be in the correct city for whatever gym you specify. |
| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)<!-- -->}\` | The stat you want to train. |
| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of gym. You must be in the correct city for whatever gym you specify. |
| stat | [GymType](./bitburner.gymtype.md) | The stat you want to train. |
| focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Quit jobs by company.
**Signature:**
```typescript
quitJob(companyName: CompanyName | `${CompanyName}`): void;
quitJob(companyName: CompanyName): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
**Returns:**

View File

@@ -9,14 +9,14 @@ Travel to another city.
**Signature:**
```typescript
travelToCity(city: CityName | `${CityName}`): boolean;
travelToCity(city: CityName): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | City to travel to. |
| city | [CityName](./bitburner.cityname.md) | City to travel to. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Take university class.
**Signature:**
```typescript
universityCourse(
universityName: UniversityLocationName | `${UniversityLocationName}`,
courseName: UniversityClassType | `${UniversityClassType}`,
focus?: boolean,
): boolean;
universityCourse(universityName: UniversityLocationName, courseName: UniversityClassType, focus?: boolean): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) \| \`${[UniversityLocationName](./bitburner.universitylocationname.md)<!-- -->}\` | Name of university. You must be in the correct city for whatever university you specify. |
| courseName | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)<!-- -->}\` | Name of course. |
| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of university. You must be in the correct city for whatever university you specify. |
| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of course. |
| focus | boolean | _(Optional)_ Acquire player focus on this class. Optional. Defaults to true. |
**Returns:**

View File

@@ -9,7 +9,7 @@ Work for a faction.
**Signature:**
```typescript
workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean;
workForFaction(faction: string, workType: FactionWorkType, focus?: boolean): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`
| Parameter | Type | Description |
| --- | --- | --- |
| faction | string | Name of faction to work for. |
| workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)<!-- -->}\` | Type of work to perform for the faction. |
| workType | [FactionWorkType](./bitburner.factionworktype.md) | Type of work to perform for the faction. |
| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. |
**Returns:**

View File

@@ -11,7 +11,7 @@ Set a sleeve to perform Bladeburner actions.
```typescript
setToBladeburnerAction(
sleeveNumber: number,
action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`,
action: BladeburnerActionTypeForSleeve,
contract?: BladeburnerContractName,
): boolean;
```
@@ -21,7 +21,7 @@ setToBladeburnerAction(
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to perform a Bladeburner action. |
| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) \| \`${[BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md)<!-- -->}\` | Name of the action to be performed. |
| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | Name of the action to be performed. |
| contract | [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | _(Optional)_ Name of the contract if applicable. |
**Returns:**

View File

@@ -9,7 +9,7 @@ Set a sleeve to commit crime.
**Signature:**
```typescript
setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean;
setToCommitCrime(sleeveNumber: number, crimeType: CrimeType): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): b
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. |
| crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | Name of the crime. |
| crimeType | [CrimeType](./bitburner.crimetype.md) | Name of the crime. |
**Returns:**

View File

@@ -9,7 +9,7 @@ Set a sleeve to work for a company.
**Signature:**
```typescript
setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName}`): boolean;
setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to work for the company. |
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company to work for. |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company to work for. |
**Returns:**

View File

@@ -9,11 +9,7 @@ Set a sleeve to work for a faction.
**Signature:**
```typescript
setToFactionWork(
sleeveNumber: number,
factionName: string,
factionWorkType: FactionWorkType | `${FactionWorkType}`,
): boolean | undefined;
setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: FactionWorkType): boolean | undefined;
```
## Parameters
@@ -22,7 +18,7 @@ setToFactionWork(
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to work for the faction. |
| factionName | string | Name of the faction to work for. |
| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)<!-- -->}\` | Name of the action to perform for this faction. |
| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) | Name of the action to perform for this faction. |
**Returns:**

View File

@@ -9,11 +9,7 @@ Set a sleeve to workout at the gym.
**Signature:**
```typescript
setToGymWorkout(
sleeveNumber: number,
gymName: GymLocationName | `${GymLocationName}`,
stat: GymType | `${GymType}`,
): boolean;
setToGymWorkout(sleeveNumber: number, gymName: GymLocationName, stat: GymType): boolean;
```
## Parameters
@@ -21,8 +17,8 @@ setToGymWorkout(
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to workout at the gym. |
| gymName | [GymLocationName](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)<!-- -->}\` | Name of the gym. |
| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)<!-- -->}\` | Name of the stat to train. |
| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of the gym. |
| stat | [GymType](./bitburner.gymtype.md) | Name of the stat to train. |
**Returns:**

View File

@@ -11,8 +11,8 @@ Set a sleeve to take a class at a university.
```typescript
setToUniversityCourse(
sleeveNumber: number,
universityName: UniversityLocationName | `${UniversityLocationName}`,
courseName: UniversityClassType | `${UniversityClassType}`,
universityName: UniversityLocationName,
courseName: UniversityClassType,
): boolean;
```
@@ -21,8 +21,8 @@ setToUniversityCourse(
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to start taking class. |
| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) \| \`${[UniversityLocationName](./bitburner.universitylocationname.md)<!-- -->}\` | Name of the university to attend. |
| courseName | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)<!-- -->}\` | Name of the course to follow. |
| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of the university to attend. |
| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of the course to follow. |
**Returns:**

View File

@@ -9,7 +9,7 @@ Make a sleeve travel to another city. The cost for using this function is the sa
**Signature:**
```typescript
travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean;
travel(sleeveNumber: number, city: CityName): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to travel. |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the destination city. |
| city | [CityName](./bitburner.cityname.md) | Name of the destination city. |
**Returns:**

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