This commit is contained in:
Olivier Gagnon 2021-11-03 00:33:14 -04:00
parent 2b79871c02
commit d82f3e7ad7
71 changed files with 1313 additions and 1366 deletions

179
dist/bitburner.d.ts vendored

@ -875,6 +875,25 @@ export declare interface CrimeStats {
intelligence_exp: number;
}
/**
* Object representing data representing a gang member equipment.
* @public
*/
export declare interface EquipmentStats {
/** Strength multiplier */
str: number;
/** Defense multiplier */
def: number;
/** Dexterity multiplier */
dex: number;
/** Agility multiplier */
agi: number;
/** Charisma multiplier */
cha: number;
/** Hacking multiplier */
hack: number;
}
/**
* Gang API
* @remarks
@ -989,7 +1008,7 @@ export declare interface Gang {
* @param name - Name of the task.
* @returns Detailed stats of a task.
*/
getTaskStats(name: string): stringStats;
getTaskStats(name: string): GangTaskStats;
/**
* List equipment names.
@ -1038,7 +1057,7 @@ export declare interface Gang {
* @param equipName - Name of equipment.
* @returns A dictionary containing the stats of the equipment.
*/
getEquipmentStats(equipName: string): stringStats;
getEquipmentStats(equipName: string): EquipmentStats;
/**
* Purchase an equipment for a gang member.
@ -1202,10 +1221,10 @@ export declare interface GangMemberInfo {
/**
* @public
*/
export declare type GangOtherInfo = {
export declare interface GangOtherInfo {
/** Stock Symbol */
[key: string]: GangOtherInfoObject[];
};
}
/**
* @public
@ -1217,6 +1236,55 @@ export declare interface GangOtherInfoObject {
territory: number;
}
/**
* Object representing data representing a gang member task.
* @public
*/
export declare interface GangTaskStats {
/** Task name */
name: string;
/** Task Description */
desc: string;
/** Is a task of a hacking gang */
isHacking: boolean;
/** Is a task of a combat gang */
isCombat: boolean;
/** Base respect earned */
baseRespect: number;
/** Base wanted earned */
baseWanted: number;
/** Base money earned */
baseMoney: number;
/** Hacking skill impact on task scaling */
hackWeight: number;
/** Stength skill impact on task scaling */
strWeight: number;
/** Defense skill impact on task scaling */
defWeight: number;
/** Dexterity skill impact on task scaling */
dexWeight: number;
/** Agility skill impact on task scaling */
agiWeight: number;
/** Charisma skill impact on task scaling */
chaWeight: number;
/** Number representing the difficulty of the task */
difficulty: number;
/** Territory impact on task scaling */
territory: GangTerritory;
}
/**
* @public
*/
export declare interface GangTerritory {
/** Money gain impact on task scaling */
money: number;
/** Respect gain impact on task scaling */
respect: number;
/** Wanted gain impact on task scaling */
wanted: number;
}
/**
* Hack related multipliers.
* @public
@ -1512,11 +1580,6 @@ export declare interface HacknetMultipliers {
levelCost: number;
}
/**
* @public
*/
export declare type Handle = string | Port;
/**
* Object representing all the values related to a hacknet node.
* @public
@ -2573,7 +2636,7 @@ export declare interface NS extends Singularity {
* @param data - Data to write.
* @param mode - Defines the write mode. Only valid when writing to text files.
*/
write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void;
write(handle: string | number, data?: string[] | number, mode?: "w" | "a"): void;
/**
* Attempts to write data to the specified Netscript Port.
@ -2585,7 +2648,7 @@ export declare interface NS extends Singularity {
* @param data - Data to write.
* @returns True if the data is successfully written to the port, and false otherwise.
*/
tryWrite(port: Handle, data: string[] | number): boolean;
tryWrite(port: number, data: string[] | number): boolean;
/**
* This function is used to read data from a port or from a text file (.txt).
@ -2603,7 +2666,7 @@ export declare interface NS extends Singularity {
* @param handle - Port or text file to read from.
* @returns Data in the specified text file or port.
*/
read(handle: Handle): string | number | object;
read(handle: string | number): string | number | object;
/**
* This function is used to peek at the data from a port. It returns the
@ -2614,7 +2677,7 @@ export declare interface NS extends Singularity {
* @param port - Port to peek. Must be an integer between 1 and 20.
* @returns Data in the specified port.
*/
peek(port: Port): string | number | object;
peek(port: number): string | number | object;
/**
* This function is used to clear data in a Netscript Ports or a text file.
@ -2628,7 +2691,7 @@ export declare interface NS extends Singularity {
* @remarks RAM cost: 1 GB
* @param handle - Port or text file to clear.
*/
clear(handle: Handle): void;
clear(handle: string | number): void;
/**
* Get a handle to a Netscript Port.
@ -2640,7 +2703,7 @@ export declare interface NS extends Singularity {
* @param port - Port number. Must be an integer between 1 and 20.
* @returns Data in the specified port.
*/
getPortHandle(port: Port): any[];
getPortHandle(port: number): any[];
/**
* Removes the specified file from the current server. This function works for every file
@ -2919,20 +2982,6 @@ export declare interface PlayerSkills {
intelligence: number;
}
/**
* Queue used to send and receive messages.
* @remarks
* A port is implemented as a sort of serialized queue,
* where you can only write and read one element at a time from the port.
* When you read data from a port, the element that is read is removed from the port.
*
* IMPORTANT: The data inside ports are not saved!
* This means if you close and re-open the game, or reload the page
* then you will lose all of the data in the ports!
* @public
*/
export declare type Port = number;
/**
* A single process on a server.
* @public
@ -3892,10 +3941,10 @@ export declare interface SourceFileLvl {
* Return value of {@link TIX.getOrders | getOrders}
* @public
*/
export declare type StockOrder = {
export declare interface StockOrder {
/** Stock Symbol */
[key: string]: StockOrderObject[];
};
}
/**
* Value in map of {@link StockOrder}
@ -3912,74 +3961,6 @@ export declare interface StockOrderObject {
position: string;
}
/**
* Object representing data representing a gang member task.
* @public
*/
export declare interface stringStats {
/** Task name */
name: string;
/** Task Description */
desc: string;
/** Is a task of a hacking gang */
isHacking: boolean;
/** Is a task of a combat gang */
isCombat: boolean;
/** Base respect earned */
baseRespect: number;
/** Base wanted earned */
baseWanted: number;
/** Base money earned */
baseMoney: number;
/** Hacking skill impact on task scaling */
hackWeight: number;
/** Stength skill impact on task scaling */
strWeight: number;
/** Defense skill impact on task scaling */
defWeight: number;
/** Dexterity skill impact on task scaling */
dexWeight: number;
/** Agility skill impact on task scaling */
agiWeight: number;
/** Charisma skill impact on task scaling */
chaWeight: number;
/** Number representing the difficulty of the task */
difficulty: number;
/** Territory impact on task scaling */
territory: stringTerritory;
}
/**
* Object representing data representing a gang member equipment.
* @public
*/
export declare interface stringStats {
/** Strength multiplier */
str: number;
/** Defense multiplier */
def: number;
/** Dexterity multiplier */
dex: number;
/** Agility multiplier */
agi: number;
/** Charisma multiplier */
cha: number;
/** Hacking multiplier */
hack: number;
}
/**
* @public
*/
export declare interface stringTerritory {
/** Money gain impact on task scaling */
money: number;
/** Respect gain impact on task scaling */
respect: number;
/** Wanted gain impact on task scaling */
wanted: number;
}
/**
* Stock market API
* @public

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

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

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

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

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

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

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

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

@ -9,7 +9,7 @@ Get stats of an equipment.
<b>Signature:</b>
```typescript
getEquipmentStats(equipName: string): stringStats;
getEquipmentStats(equipName: string): EquipmentStats;
```
## Parameters
@ -20,7 +20,7 @@ getEquipmentStats(equipName: string): stringStats;
<b>Returns:</b>
[stringStats](./bitburner.stringstats.md)
[EquipmentStats](./bitburner.equipmentstats.md)
A dictionary containing the stats of the equipment.

@ -9,7 +9,7 @@ Get stats of a task.
<b>Signature:</b>
```typescript
getTaskStats(name: string): stringStats;
getTaskStats(name: string): GangTaskStats;
```
## Parameters
@ -20,7 +20,7 @@ getTaskStats(name: string): stringStats;
<b>Returns:</b>
[stringStats](./bitburner.stringstats.md)
[GangTaskStats](./bitburner.gangtaskstats.md)
Detailed stats of a task.

@ -2,15 +2,11 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangOtherInfo](./bitburner.gangotherinfo.md)
## GangOtherInfo type
## GangOtherInfo interface
<b>Signature:</b>
```typescript
type GangOtherInfo = {
[key: string]: GangOtherInfoObject[];
};
interface GangOtherInfo
```
<b>References:</b> [GangOtherInfoObject](./bitburner.gangotherinfoobject.md)

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [agiWeight](./bitburner.gangtaskstats.agiweight.md)
## GangTaskStats.agiWeight property
Agility skill impact on task scaling
<b>Signature:</b>
```typescript
agiWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [baseMoney](./bitburner.gangtaskstats.basemoney.md)
## GangTaskStats.baseMoney property
Base money earned
<b>Signature:</b>
```typescript
baseMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [baseRespect](./bitburner.gangtaskstats.baserespect.md)
## GangTaskStats.baseRespect property
Base respect earned
<b>Signature:</b>
```typescript
baseRespect: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [baseWanted](./bitburner.gangtaskstats.basewanted.md)
## GangTaskStats.baseWanted property
Base wanted earned
<b>Signature:</b>
```typescript
baseWanted: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [chaWeight](./bitburner.gangtaskstats.chaweight.md)
## GangTaskStats.chaWeight property
Charisma skill impact on task scaling
<b>Signature:</b>
```typescript
chaWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [defWeight](./bitburner.gangtaskstats.defweight.md)
## GangTaskStats.defWeight property
Defense skill impact on task scaling
<b>Signature:</b>
```typescript
defWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [desc](./bitburner.gangtaskstats.desc.md)
## GangTaskStats.desc property
Task Description
<b>Signature:</b>
```typescript
desc: string;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [dexWeight](./bitburner.gangtaskstats.dexweight.md)
## GangTaskStats.dexWeight property
Dexterity skill impact on task scaling
<b>Signature:</b>
```typescript
dexWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [difficulty](./bitburner.gangtaskstats.difficulty.md)
## GangTaskStats.difficulty property
Number representing the difficulty of the task
<b>Signature:</b>
```typescript
difficulty: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [hackWeight](./bitburner.gangtaskstats.hackweight.md)
## GangTaskStats.hackWeight property
Hacking skill impact on task scaling
<b>Signature:</b>
```typescript
hackWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [isCombat](./bitburner.gangtaskstats.iscombat.md)
## GangTaskStats.isCombat property
Is a task of a combat gang
<b>Signature:</b>
```typescript
isCombat: boolean;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [isHacking](./bitburner.gangtaskstats.ishacking.md)
## GangTaskStats.isHacking property
Is a task of a hacking gang
<b>Signature:</b>
```typescript
isHacking: boolean;
```

@ -0,0 +1,34 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md)
## GangTaskStats interface
Object representing data representing a gang member task.
<b>Signature:</b>
```typescript
interface GangTaskStats
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [agiWeight](./bitburner.gangtaskstats.agiweight.md) | number | Agility skill impact on task scaling |
| [baseMoney](./bitburner.gangtaskstats.basemoney.md) | number | Base money earned |
| [baseRespect](./bitburner.gangtaskstats.baserespect.md) | number | Base respect earned |
| [baseWanted](./bitburner.gangtaskstats.basewanted.md) | number | Base wanted earned |
| [chaWeight](./bitburner.gangtaskstats.chaweight.md) | number | Charisma skill impact on task scaling |
| [defWeight](./bitburner.gangtaskstats.defweight.md) | number | Defense skill impact on task scaling |
| [desc](./bitburner.gangtaskstats.desc.md) | string | Task Description |
| [dexWeight](./bitburner.gangtaskstats.dexweight.md) | number | Dexterity skill impact on task scaling |
| [difficulty](./bitburner.gangtaskstats.difficulty.md) | number | Number representing the difficulty of the task |
| [hackWeight](./bitburner.gangtaskstats.hackweight.md) | number | Hacking skill impact on task scaling |
| [isCombat](./bitburner.gangtaskstats.iscombat.md) | boolean | Is a task of a combat gang |
| [isHacking](./bitburner.gangtaskstats.ishacking.md) | boolean | Is a task of a hacking gang |
| [name](./bitburner.gangtaskstats.name.md) | string | Task name |
| [strWeight](./bitburner.gangtaskstats.strweight.md) | number | Stength skill impact on task scaling |
| [territory](./bitburner.gangtaskstats.territory.md) | [GangTerritory](./bitburner.gangterritory.md) | Territory impact on task scaling |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [name](./bitburner.gangtaskstats.name.md)
## GangTaskStats.name property
Task name
<b>Signature:</b>
```typescript
name: string;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [strWeight](./bitburner.gangtaskstats.strweight.md)
## GangTaskStats.strWeight property
Stength skill impact on task scaling
<b>Signature:</b>
```typescript
strWeight: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTaskStats](./bitburner.gangtaskstats.md) &gt; [territory](./bitburner.gangtaskstats.territory.md)
## GangTaskStats.territory property
Territory impact on task scaling
<b>Signature:</b>
```typescript
territory: GangTerritory;
```

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTerritory](./bitburner.gangterritory.md)
## GangTerritory interface
<b>Signature:</b>
```typescript
interface GangTerritory
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [money](./bitburner.gangterritory.money.md) | number | Money gain impact on task scaling |
| [respect](./bitburner.gangterritory.respect.md) | number | Respect gain impact on task scaling |
| [wanted](./bitburner.gangterritory.wanted.md) | number | Wanted gain impact on task scaling |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTerritory](./bitburner.gangterritory.md) &gt; [money](./bitburner.gangterritory.money.md)
## GangTerritory.money property
Money gain impact on task scaling
<b>Signature:</b>
```typescript
money: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTerritory](./bitburner.gangterritory.md) &gt; [respect](./bitburner.gangterritory.respect.md)
## GangTerritory.respect property
Respect gain impact on task scaling
<b>Signature:</b>
```typescript
respect: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangTerritory](./bitburner.gangterritory.md) &gt; [wanted](./bitburner.gangterritory.wanted.md)
## GangTerritory.wanted property
Wanted gain impact on task scaling
<b>Signature:</b>
```typescript
wanted: number;
```

@ -1,14 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Handle](./bitburner.handle.md)
## Handle type
<b>Signature:</b>
```typescript
type Handle = string | Port;
```
<b>References:</b> [Port](./bitburner.port.md)

@ -19,11 +19,15 @@
| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. |
| [CodingContract](./bitburner.codingcontract.md) | Coding Contact API |
| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
| [Gang](./bitburner.gang.md) | Gang API |
| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
| [GangMemberAscension](./bitburner.gangmemberascension.md) | |
| [GangMemberInfo](./bitburner.gangmemberinfo.md) | |
| [GangOtherInfo](./bitburner.gangotherinfo.md) | |
| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
| [GangTerritory](./bitburner.gangterritory.md) | |
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
| [Hacknet](./bitburner.hacknet.md) | Hacknet API |
| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
@ -39,17 +43,7 @@
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
| [stringStats](./bitburner.stringstats.md) | Object representing data representing a gang member task. |
| [stringTerritory](./bitburner.stringterritory.md) | |
| [TIX](./bitburner.tix.md) | Stock market API |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [GangOtherInfo](./bitburner.gangotherinfo.md) | |
| [Handle](./bitburner.handle.md) | |
| [Port](./bitburner.port.md) | Queue used to send and receive messages. |
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |

@ -13,14 +13,14 @@ If the port/fn argument is a string, then it specifies the name of a text file (
<b>Signature:</b>
```typescript
clear(handle: Handle): void;
clear(handle: string | number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | [Handle](./bitburner.handle.md) | Port or text file to clear. |
| handle | string \| number | Port or text file to clear. |
<b>Returns:</b>

@ -11,14 +11,14 @@ WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not wo
<b>Signature:</b>
```typescript
getPortHandle(port: Port): any[];
getPortHandle(port: number): any[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | [Port](./bitburner.port.md) | Port number. Must be an integer between 1 and 20. |
| port | number | Port number. Must be an integer between 1 and 20. |
<b>Returns:</b>

@ -9,14 +9,14 @@ This function is used to peek at the data from a port. It returns the first elem
<b>Signature:</b>
```typescript
peek(port: Port): string | number | object;
peek(port: number): string | number | object;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | [Port](./bitburner.port.md) | Port to peek. Must be an integer between 1 and 20. |
| port | number | Port to peek. Must be an integer between 1 and 20. |
<b>Returns:</b>

@ -13,14 +13,14 @@ If the argument port/fn is a string, then it specifies the name of a text file (
<b>Signature:</b>
```typescript
read(handle: Handle): string | number | object;
read(handle: string | number): string | number | object;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | [Handle](./bitburner.handle.md) | Port or text file to read from. |
| handle | string \| number | Port or text file to read from. |
<b>Returns:</b>

@ -9,14 +9,14 @@ Attempts to write data to the specified Netscript Port. If the port is full, the
<b>Signature:</b>
```typescript
tryWrite(port: Handle, data: string[] | number): boolean;
tryWrite(port: number, data: string[] | number): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | [Handle](./bitburner.handle.md) | Port or text file that will be written to. |
| port | number | Port or text file that will be written to. |
| data | string\[\] \| number | Data to write. |
<b>Returns:</b>

@ -13,14 +13,14 @@ If the first argument is a string, then it specifies the name of a text file (.t
<b>Signature:</b>
```typescript
write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void;
write(handle: string | number, data?: string[] | number, mode?: "w" | "a"): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | [Handle](./bitburner.handle.md) | Port or text file that will be written to. |
| handle | string \| number | Port or text file that will be written to. |
| data | string\[\] \| number | Data to write. |
| mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. |

@ -1,20 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Port](./bitburner.port.md)
## Port type
Queue used to send and receive messages.
<b>Signature:</b>
```typescript
type Port = number;
```
## Remarks
A port is implemented as a sort of serialized queue, where you can only write and read one element at a time from the port. When you read data from a port, the element that is read is removed from the port.
IMPORTANT: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports!

@ -2,16 +2,12 @@
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [StockOrder](./bitburner.stockorder.md)
## StockOrder type
## StockOrder interface
Return value of [getOrders](./bitburner.tix.getorders.md)
<b>Signature:</b>
```typescript
type StockOrder = {
[key: string]: StockOrderObject[];
};
interface StockOrder
```
<b>References:</b> [StockOrderObject](./bitburner.stockorderobject.md)

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [agiWeight](./bitburner.stringstats.agiweight.md)
## stringStats.agiWeight property
Agility skill impact on task scaling
<b>Signature:</b>
```typescript
agiWeight: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [baseMoney](./bitburner.stringstats.basemoney.md)
## stringStats.baseMoney property
Base money earned
<b>Signature:</b>
```typescript
baseMoney: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [baseRespect](./bitburner.stringstats.baserespect.md)
## stringStats.baseRespect property
Base respect earned
<b>Signature:</b>
```typescript
baseRespect: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [baseWanted](./bitburner.stringstats.basewanted.md)
## stringStats.baseWanted property
Base wanted earned
<b>Signature:</b>
```typescript
baseWanted: number;
```

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [chaWeight](./bitburner.stringstats.chaweight.md)
## stringStats.chaWeight property
Charisma skill impact on task scaling
<b>Signature:</b>
```typescript
chaWeight: number;
```

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [defWeight](./bitburner.stringstats.defweight.md)
## stringStats.defWeight property
Defense skill impact on task scaling
<b>Signature:</b>
```typescript
defWeight: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [desc](./bitburner.stringstats.desc.md)
## stringStats.desc property
Task Description
<b>Signature:</b>
```typescript
desc: string;
```

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [dexWeight](./bitburner.stringstats.dexweight.md)
## stringStats.dexWeight property
Dexterity skill impact on task scaling
<b>Signature:</b>
```typescript
dexWeight: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [difficulty](./bitburner.stringstats.difficulty.md)
## stringStats.difficulty property
Number representing the difficulty of the task
<b>Signature:</b>
```typescript
difficulty: number;
```

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [hackWeight](./bitburner.stringstats.hackweight.md)
## stringStats.hackWeight property
Hacking skill impact on task scaling
<b>Signature:</b>
```typescript
hackWeight: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [isCombat](./bitburner.stringstats.iscombat.md)
## stringStats.isCombat property
Is a task of a combat gang
<b>Signature:</b>
```typescript
isCombat: boolean;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [isHacking](./bitburner.stringstats.ishacking.md)
## stringStats.isHacking property
Is a task of a hacking gang
<b>Signature:</b>
```typescript
isHacking: boolean;
```

@ -1,40 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md)
## stringStats interface
Object representing data representing a gang member task.
<b>Signature:</b>
```typescript
interface stringStats
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [agi](./bitburner.stringstats.agi.md) | number | Agility multiplier |
| [agiWeight](./bitburner.stringstats.agiweight.md) | number | Agility skill impact on task scaling |
| [baseMoney](./bitburner.stringstats.basemoney.md) | number | Base money earned |
| [baseRespect](./bitburner.stringstats.baserespect.md) | number | Base respect earned |
| [baseWanted](./bitburner.stringstats.basewanted.md) | number | Base wanted earned |
| [cha](./bitburner.stringstats.cha.md) | number | Charisma multiplier |
| [chaWeight](./bitburner.stringstats.chaweight.md) | number | Charisma skill impact on task scaling |
| [def](./bitburner.stringstats.def.md) | number | Defense multiplier |
| [defWeight](./bitburner.stringstats.defweight.md) | number | Defense skill impact on task scaling |
| [desc](./bitburner.stringstats.desc.md) | string | Task Description |
| [dex](./bitburner.stringstats.dex.md) | number | Dexterity multiplier |
| [dexWeight](./bitburner.stringstats.dexweight.md) | number | Dexterity skill impact on task scaling |
| [difficulty](./bitburner.stringstats.difficulty.md) | number | Number representing the difficulty of the task |
| [hack](./bitburner.stringstats.hack.md) | number | Hacking multiplier |
| [hackWeight](./bitburner.stringstats.hackweight.md) | number | Hacking skill impact on task scaling |
| [isCombat](./bitburner.stringstats.iscombat.md) | boolean | Is a task of a combat gang |
| [isHacking](./bitburner.stringstats.ishacking.md) | boolean | Is a task of a hacking gang |
| [name](./bitburner.stringstats.name.md) | string | Task name |
| [str](./bitburner.stringstats.str.md) | number | Strength multiplier |
| [strWeight](./bitburner.stringstats.strweight.md) | number | Stength skill impact on task scaling |
| [territory](./bitburner.stringstats.territory.md) | [stringTerritory](./bitburner.stringterritory.md) | Territory impact on task scaling |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [name](./bitburner.stringstats.name.md)
## stringStats.name property
Task name
<b>Signature:</b>
```typescript
name: string;
```

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [strWeight](./bitburner.stringstats.strweight.md)
## stringStats.strWeight property
Stength skill impact on task scaling
<b>Signature:</b>
```typescript
strWeight: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringStats](./bitburner.stringstats.md) &gt; [territory](./bitburner.stringstats.territory.md)
## stringStats.territory property
Territory impact on task scaling
<b>Signature:</b>
```typescript
territory: stringTerritory;
```

@ -1,21 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringTerritory](./bitburner.stringterritory.md)
## stringTerritory interface
<b>Signature:</b>
```typescript
interface stringTerritory
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [money](./bitburner.stringterritory.money.md) | number | Money gain impact on task scaling |
| [respect](./bitburner.stringterritory.respect.md) | number | Respect gain impact on task scaling |
| [wanted](./bitburner.stringterritory.wanted.md) | number | Wanted gain impact on task scaling |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringTerritory](./bitburner.stringterritory.md) &gt; [money](./bitburner.stringterritory.money.md)
## stringTerritory.money property
Money gain impact on task scaling
<b>Signature:</b>
```typescript
money: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringTerritory](./bitburner.stringterritory.md) &gt; [respect](./bitburner.stringterritory.respect.md)
## stringTerritory.respect property
Respect gain impact on task scaling
<b>Signature:</b>
```typescript
respect: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [stringTerritory](./bitburner.stringterritory.md) &gt; [wanted](./bitburner.stringterritory.wanted.md)
## stringTerritory.wanted property
Wanted gain impact on task scaling
<b>Signature:</b>
```typescript
wanted: number;
```

@ -162,10 +162,10 @@ interface StockOrderObject {
* Return value of {@link TIX.getOrders | getOrders}
* @public
*/
type StockOrder = {
interface StockOrder {
/** Stock Symbol */
[key: string]: StockOrderObject[];
};
}
/**
* A single process on a server.
@ -347,24 +347,6 @@ interface BitNodeMultipliers {
/** Influences how quickly the player's strength level (not exp) scales */
StrengthLevelMultiplier: number;
}
/**
* Queue used to send and receive messages.
* @remarks
* A port is implemented as a sort of serialized queue,
* where you can only write and read one element at a time from the port.
* When you read data from a port, the element that is read is removed from the port.
*
* IMPORTANT: The data inside ports are not saved!
* This means if you close and re-open the game, or reload the page
* then you will lose all of the data in the ports!
* @public
*/
type Port = number;
/**
* @public
*/
type Handle = string | Port;
/**
* Object representing all the values related to a hacknet node.
@ -571,16 +553,16 @@ interface GangOtherInfoObject {
/**
* @public
*/
type GangOtherInfo = {
interface GangOtherInfo {
/** Stock Symbol */
[key: string]: GangOtherInfoObject[];
};
}
/**
* Object representing data representing a gang member task.
* @public
*/
interface stringStats {
interface GangTaskStats {
/** Task name */
name: string;
/** Task Description */
@ -610,14 +592,14 @@ interface stringStats {
/** Number representing the difficulty of the task */
difficulty: number;
/** Territory impact on task scaling */
territory: stringTerritory;
territory: GangTerritory;
}
/**
* Object representing data representing a gang member equipment.
* @public
*/
interface stringStats {
interface EquipmentStats {
/** Strength multiplier */
str: number;
/** Defense multiplier */
@ -635,7 +617,7 @@ interface stringStats {
/**
* @public
*/
interface stringTerritory {
interface GangTerritory {
/** Money gain impact on task scaling */
money: number;
/** Respect gain impact on task scaling */
@ -2658,7 +2640,7 @@ interface Gang {
* @param name - Name of the task.
* @returns Detailed stats of a task.
*/
getTaskStats(name: string): stringStats;
getTaskStats(name: string): GangTaskStats;
/**
* List equipment names.
@ -2707,7 +2689,7 @@ interface Gang {
* @param equipName - Name of equipment.
* @returns A dictionary containing the stats of the equipment.
*/
getEquipmentStats(equipName: string): stringStats;
getEquipmentStats(equipName: string): EquipmentStats;
/**
* Purchase an equipment for a gang member.
@ -4003,7 +3985,7 @@ export interface NS extends Singularity {
* @param data - Data to write.
* @param mode - Defines the write mode. Only valid when writing to text files.
*/
write(handle: Handle, data?: string[] | number, mode?: "w" | "a"): void;
write(handle: string | number, data?: string[] | number, mode?: "w" | "a"): void;
/**
* Attempts to write data to the specified Netscript Port.
@ -4015,7 +3997,7 @@ export interface NS extends Singularity {
* @param data - Data to write.
* @returns True if the data is successfully written to the port, and false otherwise.
*/
tryWrite(port: Handle, data: string[] | number): boolean;
tryWrite(port: number, data: string[] | number): boolean;
/**
* This function is used to read data from a port or from a text file (.txt).
@ -4033,7 +4015,7 @@ export interface NS extends Singularity {
* @param handle - Port or text file to read from.
* @returns Data in the specified text file or port.
*/
read(handle: Handle): string | number | object;
read(handle: string | number): string | number | object;
/**
* This function is used to peek at the data from a port. It returns the
@ -4044,7 +4026,7 @@ export interface NS extends Singularity {
* @param port - Port to peek. Must be an integer between 1 and 20.
* @returns Data in the specified port.
*/
peek(port: Port): string | number | object;
peek(port: number): string | number | object;
/**
* This function is used to clear data in a Netscript Ports or a text file.
@ -4058,7 +4040,7 @@ export interface NS extends Singularity {
* @remarks RAM cost: 1 GB
* @param handle - Port or text file to clear.
*/
clear(handle: Handle): void;
clear(handle: string | number): void;
/**
* Get a handle to a Netscript Port.
@ -4070,7 +4052,7 @@ export interface NS extends Singularity {
* @param port - Port number. Must be an integer between 1 and 20.
* @returns Data in the specified port.
*/
getPortHandle(port: Port): any[];
getPortHandle(port: number): any[];
/**
* Removes the specified file from the current server. This function works for every file