bitburner-src/markdown/bitburner.ns.growthanalyze.md
Olivier Gagnon f4ac7344c4 doc
2022-01-08 13:25:06 -05:00

57 lines
1.8 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; [growthAnalyze](./bitburner.ns.growthanalyze.md)
## NS.growthAnalyze() method
Calculate the number of grow thread needed to grow a server by a certain multiplier.
<b>Signature:</b>
```typescript
growthAnalyze(host: string, growthAmount: number, cores?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of the target server. |
| growthAmount | number | Multiplicative factor by which the server is grown. Decimal form.. |
| cores | number | |
<b>Returns:</b>
number
The amount of grow calls needed to grow the specified server by the specified amount
## Remarks
RAM cost: 1 GB
This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage.
Warning: The value returned by this function isnt necessarily a whole number.
## Example 1
```ts
// NS1:
//For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use:
var growTimes = growthAnalyze("foodnstuff", 2);
//If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads).
```
## Example 2
```ts
// NS2:
//For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use:
const growTimes = ns.growthAnalyze("foodnstuff", 2);
//If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads).
```