mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-21 08:42:53 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
496 lines
4.7 KiB
Markdown
496 lines
4.7 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md)
|
|
|
|
## Server interface
|
|
|
|
A server. Not all servers have all of these properties - optional properties are missing on certain servers.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface Server
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[backdoorInstalled?](./bitburner.server.backdoorinstalled.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Flag indicating whether this server has a backdoor installed by a player
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[baseDifficulty?](./bitburner.server.basedifficulty.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Server's initial server security level at creation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[cpuCores](./bitburner.server.cpucores.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
How many CPU cores this server has. Affects magnitude of grow and weaken ran from this server.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[ftpPortOpen](./bitburner.server.ftpportopen.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Whether or not the FTP port is open
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hackDifficulty?](./bitburner.server.hackdifficulty.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Server Security Level
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hasAdminRights](./bitburner.server.hasadminrights.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Flag indicating whether player has admin/root access to this server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hostname](./bitburner.server.hostname.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Hostname. Must be unique
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[httpPortOpen](./bitburner.server.httpportopen.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Whether or not the HTTP Port is open
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[ip](./bitburner.server.ip.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
IP Address. Must be unique
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[isConnectedTo](./bitburner.server.isconnectedto.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Flag indicating whether player is currently connected to this server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[maxRam](./bitburner.server.maxram.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
RAM (GB) available on this server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[minDifficulty?](./bitburner.server.mindifficulty.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Minimum server security level that this server can be weakened to
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[moneyAvailable?](./bitburner.server.moneyavailable.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ How much money currently resides on the server and can be hacked
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[moneyMax?](./bitburner.server.moneymax.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Maximum amount of money that this server can hold
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[numOpenPortsRequired?](./bitburner.server.numopenportsrequired.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Number of open ports required in order to gain admin/root access
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[openPortCount?](./bitburner.server.openportcount.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ How many ports are currently opened on the server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[organizationName](./bitburner.server.organizationname.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of company/faction/etc. that this server belongs to, not applicable to all Servers
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[purchasedByPlayer](./bitburner.server.purchasedbyplayer.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Flag indicating whether this is a purchased server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[ramUsed](./bitburner.server.ramused.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
RAM (GB) used. i.e. unavailable RAM
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[requiredHackingSkill?](./bitburner.server.requiredhackingskill.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Hacking level required to hack this server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[serverGrowth?](./bitburner.server.servergrowth.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Growth effectiveness statistic. Higher values produce more growth with ns.grow()
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[smtpPortOpen](./bitburner.server.smtpportopen.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Whether or not the SMTP Port is open
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sqlPortOpen](./bitburner.server.sqlportopen.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Whether or not the SQL Port is open
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sshPortOpen](./bitburner.server.sshportopen.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Whether or not the SSH Port is open
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|