mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
109 lines
1.7 KiB
Markdown
109 lines
1.7 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [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
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
server
|
|
|
|
|
|
</td><td>
|
|
|
|
[Server](./bitburner.server.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Server info, typically from [getServer](./bitburner.ns.getserver.md)
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
player
|
|
|
|
|
|
</td><td>
|
|
|
|
[Person](./bitburner.person.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Player info, typically from [getPlayer](./bitburner.ns.getplayer.md)
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
threads
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Number of threads to grow with. Can be fractional.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
cores
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Number of cores on the computer that will execute grow.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
number
|
|
|
|
The amount of money after the calculated grow.
|
|
|