bitburner-src/markdown/bitburner.singularity.getcompanyfavorgain.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

33 lines
966 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getCompanyFavorGain](./bitburner.singularity.getcompanyfavorgain.md)
## Singularity.getCompanyFavorGain() method
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.
This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.
<b>Signature:</b>
```typescript
getCompanyFavorGain(companyName: CompanyName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
<b>Returns:</b>
number
Amount of favor you gain at the specified company when you reset by installing Augmentations.
## Remarks
0.75 GB Level 2