NETSCRIPT: add formulas.hacking.growAmount() (#1090)

Also, improve docs.
This commit is contained in:
David Walker
2024-03-26 03:26:50 -07:00
committed by GitHub
parent d8de22a273
commit 75dabd10be
10 changed files with 132 additions and 32 deletions

View File

@@ -0,0 +1,33 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HackingFormulas](./bitburner.hackingformulas.md) &gt; [growAmount](./bitburner.hackingformulas.growamount.md)
## HackingFormulas.growAmount() method
Calculate the amount of money a grow action will leave a server with. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md)<!-- -->, what matters is the state of the server and player when the grow \*finishes\*, not when it is started.
The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.
The inverse of this function is [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md)<!-- -->, although it rounds up to integer threads.
**Signature:**
```typescript
growAmount(server: Server, player: Person, threads: number, cores?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) |
| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) |
| threads | number | Number of threads to grow with. Can be fractional. |
| cores | number | _(Optional)_ Number of cores on the computer that will execute grow. |
**Returns:**
number
The amount of money after the calculated grow.