work on doc

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
+6 -6
View File
@@ -6,21 +6,21 @@
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. 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 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.
A successful `hack()` on a server will raise that servers security level by 0.002.
<b>Signature:</b>
```typescript
hack(host: Host, opts?: BasicHGWOptions): Promise<number>;
hack(host: string, opts?: BasicHGWOptions): Promise<number>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | [Host](./bitburner.host.md) | Hostname or IP of the target server to hack. |
| host | string | Hostname of the target server to hack. |
| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. |
<b>Returns:</b>
@@ -31,12 +31,12 @@ The amount of money stolen if the hack is successful, and zero otherwise.
## Remarks
0.1 GB
RAM cost: 0.1 GB
## Example
```js
```ts
hack("foodnstuff");
hack("10.1.2.3");
hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack