felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-17 06:48:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

more doc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

13
markdown/bitburner.equipmentstats.agi.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.equipmentstats.cha.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.equipmentstats.def.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.equipmentstats.dex.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.equipmentstats.hack.md Normal file
View File

@@ -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;
```

25
markdown/bitburner.equipmentstats.md Normal file
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; [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 |

13
markdown/bitburner.equipmentstats.str.md Normal file
View File

@@ -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;
```

4
markdown/bitburner.gang.getequipmentstats.md
View File

@@ -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.

4
markdown/bitburner.gang.gettaskstats.md
View File

@@ -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.

8
markdown/bitburner.gangotherinfo.md
View File

@@ -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)

13
markdown/bitburner.gangtaskstats.agiweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.basemoney.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.baserespect.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.basewanted.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.chaweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.defweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.desc.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.dexweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.difficulty.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.hackweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.iscombat.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.ishacking.md Normal file
View File

@@ -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;
```

34
markdown/bitburner.gangtaskstats.md Normal file
View File

@@ -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 |

13
markdown/bitburner.gangtaskstats.name.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.strweight.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangtaskstats.territory.md Normal file
View File

@@ -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;
```

21
markdown/bitburner.gangterritory.md Normal file
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; [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 |

13
markdown/bitburner.gangterritory.money.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangterritory.respect.md Normal file
View File

@@ -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;
```

13
markdown/bitburner.gangterritory.wanted.md Normal file
View File

@@ -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;
```

14
markdown/bitburner.handle.md
View File

@@ -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)

16
markdown/bitburner.md
View File

@@ -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) |

4
markdown/bitburner.ns.clear.md
View File

@@ -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>

4
markdown/bitburner.ns.getporthandle.md
View File

@@ -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>

4
markdown/bitburner.ns.peek.md
View File

@@ -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>

4
markdown/bitburner.ns.read.md
View File

@@ -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>

4
markdown/bitburner.ns.trywrite.md
View File

@@ -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>

4
markdown/bitburner.ns.write.md
View File

@@ -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. |

20
markdown/bitburner.port.md
View File

@@ -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!

8
markdown/bitburner.stockorder.md
View File

@@ -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)

13
markdown/bitburner.stringstats.agi.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.agiweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.basemoney.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.baserespect.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.basewanted.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.cha.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.chaweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.def.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.defweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.desc.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.dex.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.dexweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.difficulty.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.hack.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.hackweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.iscombat.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.ishacking.md
View File

@@ -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;
```

40
markdown/bitburner.stringstats.md
View File

@@ -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 |

13
markdown/bitburner.stringstats.name.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.str.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.strweight.md
View File

@@ -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;
```

13
markdown/bitburner.stringstats.territory.md
View File

@@ -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;
```

21
markdown/bitburner.stringterritory.md
View File

@@ -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 |

13
markdown/bitburner.stringterritory.money.md
View File

@@ -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;
```

13
markdown/bitburner.stringterritory.respect.md
View File

@@ -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;
```

13
markdown/bitburner.stringterritory.wanted.md
View File

@@ -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;
```