Revert "Remove markdown from git tracking (#139)"

This reverts commit bbb6e3f309.
This commit is contained in:
omuretsu
2022-10-21 11:16:00 -04:00
parent dab8c1a976
commit 06a985bdf8
1050 changed files with 23223 additions and 1 deletions
+53
View File
@@ -0,0 +1,53 @@
<!-- 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; [hack](./bitburner.ns.hack.md)
## NS.hack() method
Steal a servers money.
<b>Signature:</b>
```typescript
hack(host: string, opts?: BasicHGWOptions): Promise<number>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of the target server to hack. |
| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. |
<b>Returns:</b>
Promise&lt;number&gt;
The amount of money stolen if the hack is successful, and zero otherwise.
## Remarks
RAM cost: 0.1 GB
Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target servers security level when this function is called. In order to hack a server you must first gain root access to that server and also have the required hacking level.
A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game.
A successful `hack()` on a server will raise that servers security level by 0.002.
## Example 1
```ts
// NS1:
var earnedMoney = hack("foodnstuff");
```
## Example 2
```ts
// NS2:
let earnedMoney = await ns.hack("foodnstuff");
```