Skip to content

Commit

Permalink
API: Add types for parameters of gym-university-bladeburner API (bitb…
Browse files Browse the repository at this point in the history
  • Loading branch information
catloversg authored and Faenre committed Aug 22, 2024
1 parent 4ea6f4e commit 23d4748
Show file tree
Hide file tree
Showing 65 changed files with 1,044 additions and 468 deletions.
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactionautolevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get whether an action is set to autolevel.
**Signature:**

```typescript
getActionAutolevel(type: string, name: string): boolean;
getActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): boolean;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactioncountremaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get action count remaining.
**Signature:**

```typescript
getActionCountRemaining(type: string, name: string): number;
getActionCountRemaining(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactioncurrentlevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get the current level of an action.
**Signature:**

```typescript
getActionCurrentLevel(type: string, name: string): number;
getActionCurrentLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ Get estimate success chance of an action.
**Signature:**

```typescript
getActionEstimatedSuccessChance(type: string, name: string, sleeveNumber?: number): [number, number];
getActionEstimatedSuccessChance(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
sleeveNumber?: number,
): [number, number];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |
| sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. |

**Returns:**
Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactionmaxlevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get the maximum level of an action.
**Signature:**

```typescript
getActionMaxLevel(type: string, name: string): number;
getActionMaxLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
10 changes: 7 additions & 3 deletions markdown/bitburner.bladeburner.getactionrepgain.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ Get the reputation gain of an action.
**Signature:**

```typescript
getActionRepGain(type: string, name: string, level?: number): number;
getActionRepGain(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level?: number,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |
| level | number | _(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. |

**Returns:**
Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactionsuccesses.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get action successes.
**Signature:**

```typescript
getActionSuccesses(type: string, name: string): number;
getActionSuccesses(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getactiontime.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get the time to complete an action.
**Signature:**

```typescript
getActionTime(type: string, name: string): number;
getActionTime(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getblackopnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ List all black ops.
**Signature:**

```typescript
getBlackOpNames(): string[];
getBlackOpNames(): BladeburnerBlackOpName[];
```
**Returns:**

string\[\]
[BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)<!-- -->\[\]

Array of strings containing the names of all Bladeburner Black Ops.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getblackoprank.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Get black op required rank.
**Signature:**

```typescript
getBlackOpRank(name: string): number;
getBlackOpRank(name: BladeburnerBlackOpName): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | string | Name of BlackOp. Must be an exact match. |
| name | [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Name of BlackOp. Must be an exact match. |

**Returns:**

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getcontractnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ List all contracts.
**Signature:**

```typescript
getContractNames(): string[];
getContractNames(): BladeburnerContractName[];
```
**Returns:**

string\[\]
[BladeburnerContractName](./bitburner.bladeburnercontractname.md)<!-- -->\[\]

Array of strings containing the names of all Bladeburner contracts.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getgeneralactionnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ List all general actions.
**Signature:**

```typescript
getGeneralActionNames(): string[];
getGeneralActionNames(): BladeburnerGeneralActionName[];
```
**Returns:**

string\[\]
[BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->\[\]

Array of strings containing the names of all general Bladeburner actions.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getnextblackop.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Get an object with the name and rank requirement of the next BlackOp that can be
**Signature:**

```typescript
getNextBlackOp(): { name: string; rank: number } | null;
getNextBlackOp(): { name: BladeburnerBlackOpName; rank: number } | null;
```
**Returns:**

{ name: string; rank: number } \| null
{ name: [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)<!-- -->; rank: number } \| null

An object with the `.name` and `.rank` properties of the available BlackOp, or `null`<!-- -->.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getoperationnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ List all operations.
**Signature:**

```typescript
getOperationNames(): string[];
getOperationNames(): BladeburnerOperationName[];
```
**Returns:**

string\[\]
[BladeburnerOperationName](./bitburner.bladeburneroperationname.md)<!-- -->\[\]

Array of strings containing the names of all Bladeburner operations.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getskilllevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Get skill level.
**Signature:**

```typescript
getSkillLevel(skillName: string): number;
getSkillLevel(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| skillName | string | Name of skill. Case-sensitive and must be an exact match. |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill. Case-sensitive and must be an exact match. |

**Returns:**

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getskillnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ List all skills.
**Signature:**

```typescript
getSkillNames(): string[];
getSkillNames(): BladeburnerSkillName[];
```
**Returns:**

string\[\]
[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->\[\]

Array of strings containing the names of all general Bladeburner skills.

Expand Down
4 changes: 2 additions & 2 deletions markdown/bitburner.bladeburner.getskillupgradecost.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Get cost to upgrade skill.
**Signature:**

```typescript
getSkillUpgradeCost(skillName: string, count?: number): number;
getSkillUpgradeCost(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| skillName | string | Name of skill. Case-sensitive and must be an exact match. |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[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:**
Expand Down
9 changes: 6 additions & 3 deletions markdown/bitburner.bladeburner.getteamsize.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Get team size.
**Signature:**

```typescript
getTeamSize(type?: string, name?: string): number;
getTeamSize(
type?: BladeburnerActionType | `${BladeburnerActionType}`,
name?: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | _(Optional)_ Type of action. |
| name | string | _(Optional)_ Name of action. Must be an exact match. |
| 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. |

**Returns:**

Expand Down
10 changes: 7 additions & 3 deletions markdown/bitburner.bladeburner.setactionautolevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ Set an action autolevel.
**Signature:**

```typescript
setActionAutolevel(type: string, name: string, autoLevel: boolean): void;
setActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
autoLevel: boolean,
): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |
| autoLevel | boolean | Whether or not to autolevel this action |

**Returns:**
Expand Down
10 changes: 7 additions & 3 deletions markdown/bitburner.bladeburner.setactionlevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ Set the level of an action.
**Signature:**

```typescript
setActionLevel(type: string, name: string, level: number): void;
setActionLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level: number,
): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| 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. |
| level | number | Level to set this action to. |

**Returns:**
Expand Down
Loading

0 comments on commit 23d4748

Please sign in to comment.