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

work on doc

Browse Source
This commit is contained in:
Olivier Gagnon
2021-10-30 15:46:34 -04:00
parent 920b7325b4
commit feb0430aff
366 changed files with 3235 additions and 4238 deletions
Download Patch File Download Diff File Expand all files Collapse all files
markdown/bitburner.hacknet.md
+6 -5
View File
@@ -1,14 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HackNet](./bitburner.hacknet.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Hacknet](./bitburner.hacknet.md)
## HackNet interface
## Hacknet interface
Hacknet API
<b>Signature:</b>
```typescript
interface HackNet
interface Hacknet
```
## Methods
@@ -24,8 +25,8 @@ interface HackNet
| [hashCost(upgName)](./bitburner.hacknet.hashcost.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).<!-- -->Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. |
| [numHashes()](./bitburner.hacknet.numhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).<!-- -->Returns the number of hashes you have. |
| [numNodes()](./bitburner.hacknet.numnodes.md) | Returns the number of Hacknet Nodes you own. |
| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named \`<!-- -->hacknet-node-4<!-- -->\` will have an index of 4).<!-- -->If the player cannot afford to purchase a new Hacknet Node then the function will return -1. |
| [spendHashes(upgName, upgTarget)](./bitburner.hacknet.spendhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).<!-- -->Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.<!-- -->The name of the upgrade must be an exact match. The \`<!-- -->upgTarget<!-- -->\` argument is used for upgrades such as \`<!-- -->Reduce Minimum Security<!-- -->\`<!-- -->, which applies to a specific server. In this case, the \`<!-- -->upgTarget<!-- -->\` argument must be the hostname of the server. |
| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named <code>hacknet-node-4</code> will have an index of 4).<!-- -->If the player cannot afford to purchase a new Hacknet Node then the function will return -1. |
| [spendHashes(upgName, upgTarget)](./bitburner.hacknet.spendhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).<!-- -->Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.<!-- -->The name of the upgrade must be an exact match. The <code>upgTarget</code> argument is used for upgrades such as <code>Reduce Minimum Security</code>, which applies to a specific server. In this case, the <code>upgTarget</code> argument must be the hostname of the server. |
| [upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).<!-- -->Tries to upgrade the specified Hacknet Server’s cache n times.<!-- -->Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.<!-- -->Returns false otherwise. |
| [upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) | Tries to purchase n cores for the specified Hacknet Node.<!-- -->Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.<!-- -->Returns false otherwise. |
| [upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) | Tries to upgrade the level of the specified Hacknet Node by n.<!-- -->Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.<!-- -->Returns false otherwise. |