worm mechanic and bitnode

markdown/bitburner.md

@@ -142,6 +142,8 @@
 |  [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API |
 |  [WorkFormulas](./bitburner.workformulas.md) | Work formulas |
 |  [WorkStats](./bitburner.workstats.md) |  |
+|  [Worm](./bitburner.worm.md) | Worm API. |
+|  [WormSession](./bitburner.wormsession.md) |  |
 
 ## Type Aliases
 
@@ -174,4 +176,5 @@
 |  [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) |  |
 |  [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
 |  [Task](./bitburner.task.md) | Task |
+|  [WormParams](./bitburner.wormparams.md) |  |
 

markdown/bitburner.multipliers.home_core_cost.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; [Multipliers](./bitburner.multipliers.md) &gt; [home\_core\_cost](./bitburner.multipliers.home_core_cost.md)
+
+## Multipliers.home\_core\_cost property
+
+Multiplier to cost of core upgrade for home
+
+**Signature:**
+
+```typescript
+home_core_cost: number;
+```

markdown/bitburner.multipliers.home_ram_cost.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; [Multipliers](./bitburner.multipliers.md) &gt; [home\_ram\_cost](./bitburner.multipliers.home_ram_cost.md)
+
+## Multipliers.home\_ram\_cost property
+
+Multiplier to cost of ram upgrade for home
+
+**Signature:**
+
+```typescript
+home_ram_cost: number;
+```

markdown/bitburner.multipliers.md

@@ -42,6 +42,9 @@ interface Multipliers
 |  [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) |  | number | Multiplier to amount of money produced by Hacknet Nodes |
 |  [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) |  | number | Multiplier to cost of purchasing a Hacknet Node |
 |  [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) |  | number | Multiplier to cost of ram for a Hacknet Node |
+|  [home\_core\_cost](./bitburner.multipliers.home_core_cost.md) |  | number | Multiplier to cost of core upgrade for home |
+|  [home\_ram\_cost](./bitburner.multipliers.home_ram_cost.md) |  | number | Multiplier to cost of ram upgrade for home |
+|  [server\_cost](./bitburner.multipliers.server_cost.md) |  | number | Multiplier to cost of purchasable servers |
 |  [strength\_exp](./bitburner.multipliers.strength_exp.md) |  | number | Multiplier to strength experience gain rate |
 |  [strength](./bitburner.multipliers.strength.md) |  | number | Multiplier to strength skill |
 |  [work\_money](./bitburner.multipliers.work_money.md) |  | number | Multiplier to amount of money gained from working |

markdown/bitburner.multipliers.server_cost.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; [Multipliers](./bitburner.multipliers.md) &gt; [server\_cost](./bitburner.multipliers.server_cost.md)
+
+## Multipliers.server\_cost property
+
+Multiplier to cost of purchasable servers
+
+**Signature:**
+
+```typescript
+server_cost: number;
+```

markdown/bitburner.ns.md

@@ -49,6 +49,7 @@ export async function main(ns) {
 |  [stanek](./bitburner.ns.stanek.md) | <code>readonly</code> | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. Contains spoilers. |
 |  [stock](./bitburner.ns.stock.md) | <code>readonly</code> | [TIX](./bitburner.tix.md) | Namespace for stock functions. |
 |  [ui](./bitburner.ns.ui.md) | <code>readonly</code> | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. |
+|  [worm](./bitburner.ns.worm.md) | <code>readonly</code> | [Worm](./bitburner.worm.md) | Namespace for worm functions. |
 
 ## Methods
 

markdown/bitburner.ns.worm.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; [NS](./bitburner.ns.md) &gt; [worm](./bitburner.ns.worm.md)
+
+## NS.worm property
+
+Namespace for worm functions.
+
+**Signature:**
+
+```typescript
+readonly worm: Worm;
+```

markdown/bitburner.player.md

@@ -22,6 +22,7 @@ interface Player extends Person
 |  [karma](./bitburner.player.karma.md) |  | number |  |
 |  [location](./bitburner.player.location.md) |  | [LocationName](./bitburner.locationname.md) |  |
 |  [money](./bitburner.player.money.md) |  | number |  |
+|  [numContractsSolved](./bitburner.player.numcontractssolved.md) |  | number |  |
 |  [numPeopleKilled](./bitburner.player.numpeoplekilled.md) |  | number |  |
 |  [totalPlaytime](./bitburner.player.totalplaytime.md) |  | number |  |
 

markdown/bitburner.player.numcontractssolved.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Player](./bitburner.player.md) &gt; [numContractsSolved](./bitburner.player.numcontractssolved.md)
+
+## Player.numContractsSolved property
+
+**Signature:**
+
+```typescript
+numContractsSolved: number;
+```

markdown/bitburner.worm.attemptsolve.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [attemptSolve](./bitburner.worm.attemptsolve.md)
+
+## Worm.attemptSolve() method
+
+Attempts to solve the given session with the specified properties.
+
+**Signature:**
+
+```typescript
+attemptSolve(session: number): number | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | number | The Worm session to be targeted. |
+
+**Returns:**
+
+number \| null
+
+Returns the reward you received. Will return null if solving is on cooldown.
+
+## Remarks
+
+RAM cost: 30.4 GB
+

markdown/bitburner.worm.createnewsession.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [createNewSession](./bitburner.worm.createnewsession.md)
+
+## Worm.createNewSession() method
+
+Creates a new session.
+
+**Signature:**
+
+```typescript
+createNewSession(): number | null;
+```
+**Returns:**
+
+number \| null
+
+An identifier for the newly created session. Returns null if you cannot create a new session.
+
+## Remarks
+
+RAM cost: 16 GB
+

markdown/bitburner.worm.getcompletions.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getCompletions](./bitburner.worm.getcompletions.md)
+
+## Worm.getCompletions() method
+
+Get the current completion count of the Worm.
+
+**Signature:**
+
+```typescript
+getCompletions(): number;
+```
+**Returns:**
+
+number
+
+The number of completions.
+
+## Remarks
+
+RAM cost: 0.5 GB
+

markdown/bitburner.worm.getcontractinfluence.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getContractInfluence](./bitburner.worm.getcontractinfluence.md)
+
+## Worm.getContractInfluence() method
+
+Get the current multiplier the amount of coding contracts solved has on the Worm processing time.
+
+**Signature:**
+
+```typescript
+getContractInfluence(): number;
+```
+**Returns:**
+
+number
+
+## Remarks
+
+RAM cost: 1 GB
+

markdown/bitburner.worm.getfinishedsession.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getFinishedSession](./bitburner.worm.getfinishedsession.md)
+
+## Worm.getFinishedSession() method
+
+Get a finished session object by its identifier.
+
+**Signature:**
+
+```typescript
+getFinishedSession(session: number): WormSession;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | number |  |
+
+**Returns:**
+
+[WormSession](./bitburner.wormsession.md)
+
+An object representing the session.
+
+## Remarks
+
+RAM cost: 4 GB
+

markdown/bitburner.worm.getfinishedsessions.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getFinishedSessions](./bitburner.worm.getfinishedsessions.md)
+
+## Worm.getFinishedSessions() method
+
+Get all finished sessions.
+
+**Signature:**
+
+```typescript
+getFinishedSessions(): number[];
+```
+**Returns:**
+
+number\[\]
+
+An array of sessions.
+
+## Remarks
+
+RAM cost: 4 GB
+

markdown/bitburner.worm.getsessionlimit.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getSessionLimit](./bitburner.worm.getsessionlimit.md)
+
+## Worm.getSessionLimit() method
+
+Get the maximum number of sessions that can be active at a time.
+
+**Signature:**
+
+```typescript
+getSessionLimit(level?: number): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  level | number | _(Optional)_ The Source-File level of the Worm Bitnode. |
+
+**Returns:**
+
+number
+
+## Remarks
+
+RAM cost: 1 GB
+

markdown/bitburner.worm.getsessionmaxreward.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getSessionMaxReward](./bitburner.worm.getsessionmaxreward.md)
+
+## Worm.getSessionMaxReward() method
+
+Get the maimum reward possible for a given session.
+
+**Signature:**
+
+```typescript
+getSessionMaxReward(session: number): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | number |  |
+
+**Returns:**
+
+number
+
+The maximum reward possible. Is scaled down depending on how many properties are wrong.
+
+## Remarks
+
+RAM cost: 2 GB
+

markdown/bitburner.worm.getsessionparams.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getSessionParams](./bitburner.worm.getsessionparams.md)
+
+## Worm.getSessionParams() method
+
+Get the chosen nodes for the node specific properties.
+
+**Signature:**
+
+```typescript
+getSessionParams(session: number): WormParams;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | number | The Worm session to be targeted. |
+
+**Returns:**
+
+[WormParams](./bitburner.wormparams.md)
+
+## Remarks
+
+RAM cost: 1 GB
+

markdown/bitburner.worm.getsessionstates.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Worm](./bitburner.worm.md) &gt; [getSessionStates](./bitburner.worm.getsessionstates.md)
+
+## Worm.getSessionStates() method
+
+Get the current states the Worm has.
+
+**Signature:**
+
+```typescript
+getSessionStates(session: number): string[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | number | The Worm session to be targeted. |
+
+**Returns:**
+
+string\[\]
+
+All possible states.
+
+## Remarks
+
+RAM cost: 1 GB
+