bitburner-src/markdown/bitburner.ns.hackanalyzethreads.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

43 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- 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; [hackAnalyzeThreads](./bitburner.ns.hackanalyzethreads.md)
## NS.hackAnalyzeThreads() method
This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.
Warning: The value returned by this function isnt necessarily a whole number.
<b>Signature:</b>
```typescript
hackAnalyzeThreads(host: string, hackAmount: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of the target server to analyze. |
| hackAmount | number | Amount of money you want to hack from the server. |
<b>Returns:</b>
number
The number of threads needed to hack the server for hackAmount money.
## Remarks
RAM cost: 1 GB
## Example
```ts
//For example, lets say the foodnstuff server has $10m and you run:
hackAnalyzeThreads("foodnstuff", 1e6);
//If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.
```