felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-05-23 16:06:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

DNET: simplify getServer return type; add all missing dnet properties to getServerAuthDetails (#2746)

Browse Source
This commit is contained in:
Michael Ficocelli
2026-05-12 16:22:25 -07:00
committed by GitHub
parent 00f0756a59
commit 3acdf019f8
62 changed files with 784 additions and 1178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
markdown/bitburner.darknet.getserverauthdetails.md
-60
View File
@@ -1,60 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Darknet](./bitburner.darknet.md) &gt; [getServerAuthDetails](./bitburner.darknet.getserverauthdetails.md)
## Darknet.getServerAuthDetails() method
Returns the server's authentication protocol details.
**Signature:**
```typescript
getServerAuthDetails(host?: string): ServerAuthDetails & { isOnline: boolean };
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
host
</td><td>
string
</td><td>
_(Optional)_ Hostname/IP of the server to analyze. Defaults to the running script's server if not specified.
</td></tr>
</tbody></table>
**Returns:**
[ServerAuthDetails](./bitburner.serverauthdetails.md) &amp; { isOnline: boolean }
An object containing the server's authentication protocol details.
## Remarks
RAM cost: 0.1 GB
markdown/bitburner.darknet.getserverdetails.md
+62
View File
@@ -0,0 +1,62 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Darknet](./bitburner.darknet.md) &gt; [getServerDetails](./bitburner.darknet.getserverdetails.md)
## Darknet.getServerDetails() method
Returns the darknet-specific details of the server.
If the darknet server has recently gone offline, the returned object will be a dummy server object with `isOnline: false`<!-- -->.
**Signature:**
```typescript
getServerDetails(host?: string): DarknetServerDetails & { isOnline: boolean };
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
host
</td><td>
string
</td><td>
_(Optional)_ Hostname/IP of the server to analyze. Defaults to the running script's server if not specified.
</td></tr>
</tbody></table>
**Returns:**
[DarknetServerDetails](./bitburner.darknetserverdetails.md) &amp; { isOnline: boolean }
An object containing the server's darknet-specific details.
## Remarks
RAM cost: 0.1 GB
markdown/bitburner.darknet.md
+4 -2
View File
@@ -96,12 +96,14 @@ Returns -1 if the server is offline, not found, or not a darkweb server.
</td></tr>
<tr><td>
[getServerAuthDetails(host)](./bitburner.darknet.getserverauthdetails.md)
[getServerDetails(host)](./bitburner.darknet.getserverdetails.md)
</td><td>
Returns the server's authentication protocol details.
Returns the darknet-specific details of the server.
If the darknet server has recently gone offline, the returned object will be a dummy server object with `isOnline: false`<!-- -->.
</td></tr>
markdown/bitburner.darknetformulas.getauthenticatetime.md
+24 -3
View File
@@ -9,7 +9,12 @@ Gets the time it will take to authenticate a server.
**Signature:**
```typescript
getAuthenticateTime(darknetServerData: DarknetServerData, threads?: number, player?: Person): number;
getAuthenticateTime(
serverDetails: DarknetServerDetails,
threads?: number,
player?: Person,
correctCharactersInPassword?: number,
): number;
```
## Parameters
@@ -32,12 +37,12 @@ Description
</th></tr></thead>
<tbody><tr><td>
darknetServerData
serverDetails
</td><td>
[DarknetServerData](./bitburner.darknetserverdata.md)
[DarknetServerDetails](./bitburner.darknetserverdetails.md)
</td><td>
@@ -77,6 +82,22 @@ player
_(Optional)_ The player object. Optional, defaults to the current player status
</td></tr>
<tr><td>
correctCharactersInPassword
</td><td>
number
</td><td>
_(Optional)_ only used for 2G\_cellular model servers. The number of correct characters in the attempted password. Optional, defaults to 0
</td></tr>
</tbody></table>
markdown/bitburner.darknetformulas.getexpectedramblockremoved.md
+3 -3
View File
@@ -9,7 +9,7 @@ Gets the expected amount off ram that will be freed by a call to dnet.memoryReal
**Signature:**
```typescript
getExpectedRamBlockRemoved(darknetServerData: DarknetServerData, threads?: number, player?: Person): number;
getExpectedRamBlockRemoved(serverDetails: DarknetServerDetails, threads?: number, player?: Person): number;
```
## Parameters
@@ -32,12 +32,12 @@ Description
</th></tr></thead>
<tbody><tr><td>
darknetServerData
serverDetails
</td><td>
[DarknetServerData](./bitburner.darknetserverdata.md)
[DarknetServerDetails](./bitburner.darknetserverdetails.md)
</td><td>
markdown/bitburner.darknetformulas.getheartbleedtime.md
+3 -3
View File
@@ -9,7 +9,7 @@ Gets the time it will take to scrape logs from a server.
**Signature:**
```typescript
getHeartbleedTime(darknetServerData: DarknetServerData, threads?: number, player?: Person): number;
getHeartbleedTime(serverDetails: DarknetServerDetails, threads?: number, player?: Person): number;
```
## Parameters
@@ -32,12 +32,12 @@ Description
</th></tr></thead>
<tbody><tr><td>
darknetServerData
serverDetails
</td><td>
[DarknetServerData](./bitburner.darknetserverdata.md)
[DarknetServerDetails](./bitburner.darknetserverdetails.md)
</td><td>
markdown/bitburner.darknetformulas.md
+3 -3
View File
@@ -27,7 +27,7 @@ Description
</th></tr></thead>
<tbody><tr><td>
[getAuthenticateTime(darknetServerData, threads, player)](./bitburner.darknetformulas.getauthenticatetime.md)
[getAuthenticateTime(serverDetails, threads, player, correctCharactersInPassword)](./bitburner.darknetformulas.getauthenticatetime.md)
</td><td>
@@ -38,7 +38,7 @@ Gets the time it will take to authenticate a server.
</td></tr>
<tr><td>
[getExpectedRamBlockRemoved(darknetServerData, threads, player)](./bitburner.darknetformulas.getexpectedramblockremoved.md)
[getExpectedRamBlockRemoved(serverDetails, threads, player)](./bitburner.darknetformulas.getexpectedramblockremoved.md)
</td><td>
@@ -49,7 +49,7 @@ Gets the expected amount off ram that will be freed by a call to dnet.memoryReal
</td></tr>
<tr><td>
[getHeartbleedTime(darknetServerData, threads, player)](./bitburner.darknetformulas.getheartbleedtime.md)
[getHeartbleedTime(serverDetails, threads, player)](./bitburner.darknetformulas.getheartbleedtime.md)
</td><td>
markdown/bitburner.darknetserverdata.backdoorinstalled.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [backdoorInstalled](./bitburner.darknetserverdata.backdoorinstalled.md)
## DarknetServerData.backdoorInstalled property
Flag indicating whether this server has a backdoor installed by the player
**Signature:**
```typescript
backdoorInstalled: boolean;
```
markdown/bitburner.darknetserverdata.cpucores.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [cpuCores](./bitburner.darknetserverdata.cpucores.md)
## DarknetServerData.cpuCores property
Number of CPU cores
**Signature:**
```typescript
cpuCores: number;
```
markdown/bitburner.darknetserverdata.hasadminrights.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [hasAdminRights](./bitburner.darknetserverdata.hasadminrights.md)
## DarknetServerData.hasAdminRights property
Flag indicating whether the player has admin/root access to this server
**Signature:**
```typescript
hasAdminRights: boolean;
```
markdown/bitburner.darknetserverdata.hasstasislink.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [hasStasisLink](./bitburner.darknetserverdata.hasstasislink.md)
## DarknetServerData.hasStasisLink property
If the server has a stasis link applied
**Signature:**
```typescript
hasStasisLink: boolean;
```
markdown/bitburner.darknetserverdata.hostname.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [hostname](./bitburner.darknetserverdata.hostname.md)
## DarknetServerData.hostname property
Hostname. Must be unique
**Signature:**
```typescript
hostname: string;
```
markdown/bitburner.darknetserverdata.ip.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [ip](./bitburner.darknetserverdata.ip.md)
## DarknetServerData.ip property
IP Address. Must be unique
**Signature:**
```typescript
ip: string;
```
markdown/bitburner.darknetserverdata.isconnectedto.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [isConnectedTo](./bitburner.darknetserverdata.isconnectedto.md)
## DarknetServerData.isConnectedTo property
Flag indicating whether the player's terminal is currently connected to this server
**Signature:**
```typescript
isConnectedTo: boolean;
```
markdown/bitburner.darknetserverdata.logtrafficinterval.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [logTrafficInterval](./bitburner.darknetserverdata.logtrafficinterval.md)
## DarknetServerData.logTrafficInterval property
The interval at which the server periodically adds to its logs, in seconds.
**Signature:**
```typescript
logTrafficInterval: number;
```
markdown/bitburner.darknetserverdata.maxram.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [maxRam](./bitburner.darknetserverdata.maxram.md)
## DarknetServerData.maxRam property
Max RAM (GB) of this server
**Signature:**
```typescript
maxRam: number;
```
markdown/bitburner.darknetserverdata.md
-400
View File
@@ -1,400 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md)
## DarknetServerData interface
Darknet server data.
**Signature:**
```typescript
export interface DarknetServerData
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[backdoorInstalled](./bitburner.darknetserverdata.backdoorinstalled.md)
</td><td>
</td><td>
boolean
</td><td>
Flag indicating whether this server has a backdoor installed by the player
</td></tr>
<tr><td>
[blockedRam](./bitburner.darknetserverdata.blockedram.md)
</td><td>
</td><td>
number
</td><td>
The amount of ram blocked by the server owner
</td></tr>
<tr><td>
[cpuCores](./bitburner.darknetserverdata.cpucores.md)
</td><td>
</td><td>
number
</td><td>
Number of CPU cores
</td></tr>
<tr><td>
[depth](./bitburner.darknetserverdata.depth.md)
</td><td>
</td><td>
number
</td><td>
The depth of the server in the net
</td></tr>
<tr><td>
[difficulty](./bitburner.darknetserverdata.difficulty.md)
</td><td>
</td><td>
number
</td><td>
The difficulty rating of the server, associated with its original depth in the net
</td></tr>
<tr><td>
[hasAdminRights](./bitburner.darknetserverdata.hasadminrights.md)
</td><td>
</td><td>
boolean
</td><td>
Flag indicating whether the player has admin/root access to this server
</td></tr>
<tr><td>
[hasStasisLink](./bitburner.darknetserverdata.hasstasislink.md)
</td><td>
</td><td>
boolean
</td><td>
If the server has a stasis link applied
</td></tr>
<tr><td>
[hostname](./bitburner.darknetserverdata.hostname.md)
</td><td>
</td><td>
string
</td><td>
Hostname. Must be unique
</td></tr>
<tr><td>
[ip](./bitburner.darknetserverdata.ip.md)
</td><td>
</td><td>
string
</td><td>
IP Address. Must be unique
</td></tr>
<tr><td>
[isConnectedTo](./bitburner.darknetserverdata.isconnectedto.md)
</td><td>
</td><td>
boolean
</td><td>
Flag indicating whether the player's terminal is currently connected to this server
</td></tr>
<tr><td>
[isStationary](./bitburner.darknetserverdata.isstationary.md)
</td><td>
</td><td>
boolean
</td><td>
If this darknet server cannot be moved. True for fixed/story servers.
</td></tr>
<tr><td>
[logTrafficInterval](./bitburner.darknetserverdata.logtrafficinterval.md)
</td><td>
</td><td>
number
</td><td>
The interval at which the server periodically adds to its logs, in seconds.
</td></tr>
<tr><td>
[maxRam](./bitburner.darknetserverdata.maxram.md)
</td><td>
</td><td>
number
</td><td>
Max RAM (GB) of this server
</td></tr>
<tr><td>
[modelId](./bitburner.darknetserverdata.modelid.md)
</td><td>
</td><td>
string
</td><td>
The model of the server. Similar models have similar vulnerabilities. The model list is intentionally undocumented. You are supposed to experiment and discover the models.
</td></tr>
<tr><td>
[passwordHintData](./bitburner.darknetserverdata.passwordhintdata.md)
</td><td>
</td><td>
string
</td><td>
Data associated with the password hint
</td></tr>
<tr><td>
[purchasedByPlayer](./bitburner.darknetserverdata.purchasedbyplayer.md)
</td><td>
</td><td>
boolean
</td><td>
Whether this server was purchased by the player. Always false for darknet servers
</td></tr>
<tr><td>
[ramUsed](./bitburner.darknetserverdata.ramused.md)
</td><td>
</td><td>
number
</td><td>
Used RAM (GB). i.e. unavailable RAM
</td></tr>
<tr><td>
[requiredCharismaSkill](./bitburner.darknetserverdata.requiredcharismaskill.md)
</td><td>
</td><td>
number
</td><td>
The charisma skill required to heartbleed the server
</td></tr>
<tr><td>
[staticPasswordHint](./bitburner.darknetserverdata.staticpasswordhint.md)
</td><td>
</td><td>
string
</td><td>
The generic password prompt for the server
</td></tr>
</tbody></table>
markdown/bitburner.darknetserverdata.passwordhintdata.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [passwordHintData](./bitburner.darknetserverdata.passwordhintdata.md)
## DarknetServerData.passwordHintData property
Data associated with the password hint
**Signature:**
```typescript
passwordHintData: string;
```
markdown/bitburner.darknetserverdata.purchasedbyplayer.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [purchasedByPlayer](./bitburner.darknetserverdata.purchasedbyplayer.md)
## DarknetServerData.purchasedByPlayer property
Whether this server was purchased by the player. Always false for darknet servers
**Signature:**
```typescript
purchasedByPlayer: boolean;
```
markdown/bitburner.darknetserverdata.ramused.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [ramUsed](./bitburner.darknetserverdata.ramused.md)
## DarknetServerData.ramUsed property
Used RAM (GB). i.e. unavailable RAM
**Signature:**
```typescript
ramUsed: number;
```
markdown/bitburner.darknetserverdata.requiredcharismaskill.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [requiredCharismaSkill](./bitburner.darknetserverdata.requiredcharismaskill.md)
## DarknetServerData.requiredCharismaSkill property
The charisma skill required to heartbleed the server
**Signature:**
```typescript
requiredCharismaSkill: number;
```
markdown/bitburner.darknetserverdata.staticpasswordhint.md
-13
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; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [staticPasswordHint](./bitburner.darknetserverdata.staticpasswordhint.md)
## DarknetServerData.staticPasswordHint property
The generic password prompt for the server
**Signature:**
```typescript
staticPasswordHint: string;
```
markdown/bitburner.darknetserverdata.blockedram.md → markdown/bitburner.darknetserverdetails.blockedram.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [blockedRam](./bitburner.darknetserverdata.blockedram.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [blockedRam](./bitburner.darknetserverdetails.blockedram.md)
## DarknetServerData.blockedRam property
## DarknetServerDetails.blockedRam property
The amount of ram blocked by the server owner
markdown/bitburner.darknetserverdetails.data.md
+13
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; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [data](./bitburner.darknetserverdetails.data.md)
## DarknetServerDetails.data property
Data from the passwordHint, if any.
**Signature:**
```typescript
data: string;
```
markdown/bitburner.darknetserverdata.depth.md → markdown/bitburner.darknetserverdetails.depth.md
+3 -3
View File
@@ -1,10 +1,10 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [depth](./bitburner.darknetserverdata.depth.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [depth](./bitburner.darknetserverdetails.depth.md)
## DarknetServerData.depth property
## DarknetServerDetails.depth property
The depth of the server in the net
The current depth in the darknet of the server
**Signature:**
markdown/bitburner.darknetserverdata.difficulty.md → markdown/bitburner.darknetserverdetails.difficulty.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [difficulty](./bitburner.darknetserverdata.difficulty.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [difficulty](./bitburner.darknetserverdetails.difficulty.md)
## DarknetServerData.difficulty property
## DarknetServerDetails.difficulty property
The difficulty rating of the server, associated with its original depth in the net
markdown/bitburner.serverauthdetails.hassession.md → markdown/bitburner.darknetserverdetails.hassession.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [hasSession](./bitburner.serverauthdetails.hassession.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [hasSession](./bitburner.darknetserverdetails.hassession.md)
## ServerAuthDetails.hasSession property
## DarknetServerDetails.hasSession property
True if the current script has authenticated to this server with the right password using authenticate() or connectToSesssion()
markdown/bitburner.darknetserverdetails.isconnectedtocurrentserver.md
+13
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; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [isConnectedToCurrentServer](./bitburner.darknetserverdetails.isconnectedtocurrentserver.md)
## DarknetServerDetails.isConnectedToCurrentServer property
True if the server is directly connected to the current server
**Signature:**
```typescript
isConnectedToCurrentServer: boolean;
```
markdown/bitburner.darknetserverdata.isstationary.md → markdown/bitburner.darknetserverdetails.isstationary.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [isStationary](./bitburner.darknetserverdata.isstationary.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [isStationary](./bitburner.darknetserverdetails.isstationary.md)
## DarknetServerData.isStationary property
## DarknetServerDetails.isStationary property
If this darknet server cannot be moved. True for fixed/story servers.
markdown/bitburner.serverauthdetails.logtrafficinterval.md → markdown/bitburner.darknetserverdetails.logtrafficinterval.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [logTrafficInterval](./bitburner.serverauthdetails.logtrafficinterval.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [logTrafficInterval](./bitburner.darknetserverdetails.logtrafficinterval.md)
## ServerAuthDetails.logTrafficInterval property
## DarknetServerDetails.logTrafficInterval property
The frequency (in seconds) of the server adding its own messages to its logs, visible with heartBleed().
markdown/bitburner.darknetserverdetails.md
+286
View File
@@ -0,0 +1,286 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md)
## DarknetServerDetails interface
Details about a darknet server
**Signature:**
```typescript
interface DarknetServerDetails
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[blockedRam](./bitburner.darknetserverdetails.blockedram.md)
</td><td>
</td><td>
number
</td><td>
The amount of ram blocked by the server owner
</td></tr>
<tr><td>
[data](./bitburner.darknetserverdetails.data.md)
</td><td>
</td><td>
string
</td><td>
Data from the passwordHint, if any.
</td></tr>
<tr><td>
[depth](./bitburner.darknetserverdetails.depth.md)
</td><td>
</td><td>
number
</td><td>
The current depth in the darknet of the server
</td></tr>
<tr><td>
[difficulty](./bitburner.darknetserverdetails.difficulty.md)
</td><td>
</td><td>
number
</td><td>
The difficulty rating of the server, associated with its original depth in the net
</td></tr>
<tr><td>
[hasSession](./bitburner.darknetserverdetails.hassession.md)
</td><td>
</td><td>
boolean
</td><td>
True if the current script has authenticated to this server with the right password using authenticate() or connectToSesssion()
</td></tr>
<tr><td>
[isConnectedToCurrentServer](./bitburner.darknetserverdetails.isconnectedtocurrentserver.md)
</td><td>
</td><td>
boolean
</td><td>
True if the server is directly connected to the current server
</td></tr>
<tr><td>
[isStationary](./bitburner.darknetserverdetails.isstationary.md)
</td><td>
</td><td>
boolean
</td><td>
If this darknet server cannot be moved. True for fixed/story servers.
</td></tr>
<tr><td>
[logTrafficInterval](./bitburner.darknetserverdetails.logtrafficinterval.md)
</td><td>
</td><td>
number
</td><td>
The frequency (in seconds) of the server adding its own messages to its logs, visible with heartBleed().
</td></tr>
<tr><td>
[modelId](./bitburner.darknetserverdetails.modelid.md)
</td><td>
</td><td>
string
</td><td>
The model of the server. Similar models have similar vulnerabilities. The model list is intentionally undocumented. You are supposed to experiment and discover the models.
</td></tr>
<tr><td>
[passwordFormat](./bitburner.darknetserverdetails.passwordformat.md)
</td><td>
</td><td>
"numeric" \| "alphabetic" \| "alphanumeric" \| "ASCII" \| "unicode"
</td><td>
The character set used in the password
</td></tr>
<tr><td>
[passwordHint](./bitburner.darknetserverdetails.passwordhint.md)
</td><td>
</td><td>
string
</td><td>
Static password reminder text set for this server.
</td></tr>
<tr><td>
[passwordLength](./bitburner.darknetserverdetails.passwordlength.md)
</td><td>
</td><td>
number
</td><td>
The number of characters in the password
</td></tr>
<tr><td>
[requiredCharismaSkill](./bitburner.darknetserverdetails.requiredcharismaskill.md)
</td><td>
</td><td>
number
</td><td>
The charisma skill required to authenticate on the server
</td></tr>
</tbody></table>
markdown/bitburner.darknetserverdata.modelid.md → markdown/bitburner.darknetserverdetails.modelid.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerData](./bitburner.darknetserverdata.md) &gt; [modelId](./bitburner.darknetserverdata.modelid.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [modelId](./bitburner.darknetserverdetails.modelid.md)
## DarknetServerData.modelId property
## DarknetServerDetails.modelId property
The model of the server. Similar models have similar vulnerabilities. The model list is intentionally undocumented. You are supposed to experiment and discover the models.
markdown/bitburner.serverauthdetails.passwordformat.md → markdown/bitburner.darknetserverdetails.passwordformat.md
+2 -2
View File
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordFormat](./bitburner.serverauthdetails.passwordformat.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [passwordFormat](./bitburner.darknetserverdetails.passwordformat.md)
## ServerAuthDetails.passwordFormat property
## DarknetServerDetails.passwordFormat property
The character set used in the password
markdown/bitburner.darknetserverdetails.passwordhint.md
+13
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; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [passwordHint](./bitburner.darknetserverdetails.passwordhint.md)
## DarknetServerDetails.passwordHint property
Static password reminder text set for this server.
**Signature:**
```typescript
passwordHint: string;
```
markdown/bitburner.darknetserverdetails.passwordlength.md
+13
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; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [passwordLength](./bitburner.darknetserverdetails.passwordlength.md)
## DarknetServerDetails.passwordLength property
The number of characters in the password
**Signature:**
```typescript
passwordLength: number;
```
markdown/bitburner.darknetserverdetails.requiredcharismaskill.md
+13
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; [DarknetServerDetails](./bitburner.darknetserverdetails.md) &gt; [requiredCharismaSkill](./bitburner.darknetserverdetails.requiredcharismaskill.md)
## DarknetServerDetails.requiredCharismaSkill property
The charisma skill required to authenticate on the server
**Signature:**
```typescript
requiredCharismaSkill: number;
```
markdown/bitburner.md
+2 -13
View File
@@ -382,12 +382,12 @@ Instability of the darknet caused by excessive backdoor-ing of servers.
</td></tr>
<tr><td>
[DarknetServerData](./bitburner.darknetserverdata.md)
[DarknetServerDetails](./bitburner.darknetserverdetails.md)
</td><td>
Darknet server data.
Details about a darknet server
</td></tr>
@@ -1218,17 +1218,6 @@ Various info about resets
A server. Not all servers have all of these properties - optional properties are missing on certain servers.
</td></tr>
<tr><td>
[ServerAuthDetails](./bitburner.serverauthdetails.md)
</td><td>
Details about a server's authentication schema
</td></tr>
<tr><td>
markdown/bitburner.ns.getserver.md
+3 -3
View File
@@ -6,12 +6,12 @@
Returns data of a server.
If the server is a darknet server and has recently gone offline, it will return a dummy server object with `isOnline: false`<!-- -->.
If the server is a darknet server, it will also contain the "isOnline" field. If the darknet server has recently gone offline, the returned object will be a dummy server object with `isOnline: false`<!-- -->.
**Signature:**
```typescript
getServer(host?: string): Server | (DarknetServerData & { isOnline: boolean });
getServer(host?: string): Server & { isOnline?: boolean };
```
## Parameters
@@ -52,7 +52,7 @@ _(Optional)_ Optional. Hostname/IP of the server. Defaults to the hostname of th
**Returns:**
[Server](./bitburner.server.md) \| ([DarknetServerData](./bitburner.darknetserverdata.md) &amp; { isOnline: boolean })
[Server](./bitburner.server.md) &amp; { isOnline?: boolean }
Data of the server.
markdown/bitburner.ns.md
+1 -1
View File
@@ -929,7 +929,7 @@ Get the ram cost of a script.
Returns data of a server.
If the server is a darknet server and has recently gone offline, it will return a dummy server object with `isOnline: false`<!-- -->.
If the server is a darknet server, it will also contain the "isOnline" field. If the darknet server has recently gone offline, the returned object will be a dummy server object with `isOnline: false`<!-- -->.
</td></tr>
markdown/bitburner.serverauthdetails.data.md
-13
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; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [data](./bitburner.serverauthdetails.data.md)
## ServerAuthDetails.data property
Data from the passwordHint, if any.
**Signature:**
```typescript
data: string;
```
markdown/bitburner.serverauthdetails.isconnectedtocurrentserver.md
-13
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; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [isConnectedToCurrentServer](./bitburner.serverauthdetails.isconnectedtocurrentserver.md)
## ServerAuthDetails.isConnectedToCurrentServer property
True if the server is directly connected to the current server
**Signature:**
```typescript
isConnectedToCurrentServer: boolean;
```
markdown/bitburner.serverauthdetails.md
-191
View File
@@ -1,191 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md)
## ServerAuthDetails interface
Details about a server's authentication schema
**Signature:**
```typescript
interface ServerAuthDetails
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[data](./bitburner.serverauthdetails.data.md)
</td><td>
</td><td>
string
</td><td>
Data from the passwordHint, if any.
</td></tr>
<tr><td>
[hasSession](./bitburner.serverauthdetails.hassession.md)
</td><td>
</td><td>
boolean
</td><td>
True if the current script has authenticated to this server with the right password using authenticate() or connectToSesssion()
</td></tr>
<tr><td>
[isConnectedToCurrentServer](./bitburner.serverauthdetails.isconnectedtocurrentserver.md)
</td><td>
</td><td>
boolean
</td><td>
True if the server is directly connected to the current server
</td></tr>
<tr><td>
[logTrafficInterval](./bitburner.serverauthdetails.logtrafficinterval.md)
</td><td>
</td><td>
number
</td><td>
The frequency (in seconds) of the server adding its own messages to its logs, visible with heartBleed().
</td></tr>
<tr><td>
[modelId](./bitburner.serverauthdetails.modelid.md)
</td><td>
</td><td>
string
</td><td>
The model ID of the server. Similar models share vulnerabilities.
</td></tr>
<tr><td>
[passwordFormat](./bitburner.serverauthdetails.passwordformat.md)
</td><td>
</td><td>
"numeric" \| "alphabetic" \| "alphanumeric" \| "ASCII" \| "unicode"
</td><td>
The character set used in the password
</td></tr>
<tr><td>
[passwordHint](./bitburner.serverauthdetails.passwordhint.md)
</td><td>
</td><td>
string
</td><td>
Static password reminder text set for this server.
</td></tr>
<tr><td>
[passwordLength](./bitburner.serverauthdetails.passwordlength.md)
</td><td>
</td><td>
number
</td><td>
The number of characters in the password
</td></tr>
</tbody></table>
markdown/bitburner.serverauthdetails.modelid.md
-13
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; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [modelId](./bitburner.serverauthdetails.modelid.md)
## ServerAuthDetails.modelId property
The model ID of the server. Similar models share vulnerabilities.
**Signature:**
```typescript
modelId: string;
```
markdown/bitburner.serverauthdetails.passwordhint.md
-13
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; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordHint](./bitburner.serverauthdetails.passwordhint.md)
## ServerAuthDetails.passwordHint property
Static password reminder text set for this server.
**Signature:**
```typescript
passwordHint: string;
```
markdown/bitburner.serverauthdetails.passwordlength.md
-13
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; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordLength](./bitburner.serverauthdetails.passwordlength.md)
## ServerAuthDetails.passwordLength property
The number of characters in the password
**Signature:**
```typescript
passwordLength: number;
```